This class contains the parameters needed for grouping the values of a Property. More...

#include <Grouping.h>

Public Member Functions
Grouping *	clone ()

const size_t	getNumSlices () const
	It gets the number of slices used in the Equal Steps and Quantil groupings.

const size_t	getPrecision () const
	It gets the precision used for the property values.

std::string	getPropertyName () const
	It gets the property name whose values will be grouped.

int	getPropertyType () const
	It gets the property type whose values will be grouped.

const double	getStdDeviation () const
	It gets the standard deviation used in the Standard Deviation grouping.

std::string	getSummary () const
	It gets the grouping summary. It is used only in case 1 to n.

const GroupingType	getType () const
	It gets the grouping type.

	Grouping (const Grouping &rhs)
	Copy constructor.

	Grouping (const std::string &propertyName, GroupingType type, size_t precision=6)
	It constructs a new Grouping instance.

bool	isVisible () const
	It gets the grouping visibility.

void	setNumSlices (size_t numSlices)
	It sets the number of slices for the EqualSteps and Quantil groupings.

void	setPrecision (size_t precision)
	It sets the precision to be used for the property values.

void	setPropertyName (const std::string &name)
	It sets the property name whose values will be grouped.

void	setPropertyType (const int &type)
	It sets the property type whose values will be grouped.

void	setStdDeviation (double stdDeviation)
	It sets the standard deviation for the Standard Deviation grouping.

void	setSummary (const std::string &summary)
	It gets the grouping summary. It is used only in case 1 to n.

void	setType (GroupingType type)
	It sets the grouping type.

void	setVisibility (bool visible)
	It sets the grouping visibility.

	~Grouping ()
	Destructor.

Private Attributes
bool	m_isVisible
	A flag that indicates if the grouping is visible.

size_t	m_numSlices
	The number of slices used in the Equal Steps and Quantil groupings.

size_t	m_precision
	The precision of the values.

std::string	m_propertyName
	The property name whose values will be used to make the grouping.

int	m_propertyType
	The property type whose values will be used to make the grouping.

double	m_stdDeviation
	The standard deviation used in the Standard Deviation grouping.

std::string	m_summary
	The summary used in case 1 to n.

GroupingType	m_type
	The grouping type.

Detailed Description

This class contains the parameters needed for grouping the values of a Property.

See also: Layer

Definition at line 57 of file Grouping.h.

Constructor & Destructor Documentation

◆ Grouping() [1/2]

te::map::Grouping::Grouping	(	const std::string &	propertyName,
		GroupingType	type,
		size_t	precision = `6`
	)

It constructs a new Grouping instance.

Parameters

propertyName	The property name whose values will be used to make the grouping.
type	The grouping type.
precision	The precision to be set to the property values.

◆ ~Grouping()

te::map::Grouping::~Grouping ( )

Destructor.

◆ Grouping() [2/2]

te::map::Grouping::Grouping ( const Grouping & rhs )

Copy constructor.

Member Function Documentation

◆ clone()

Grouping * te::map::Grouping::clone ( )

◆ getNumSlices()

const size_t te::map::Grouping::getNumSlices ( ) const

It gets the number of slices used in the Equal Steps and Quantil groupings.

\output The number of slices.

◆ getPrecision()

const size_t te::map::Grouping::getPrecision ( ) const

It gets the precision used for the property values.

\output The precision used for the property values.

◆ getPropertyName()

std::string te::map::Grouping::getPropertyName ( ) const

It gets the property name whose values will be grouped.

Returns: The property name.

◆ getPropertyType()

int te::map::Grouping::getPropertyType ( ) const

It gets the property type whose values will be grouped.

Returns: The property type.

◆ getStdDeviation()

const double te::map::Grouping::getStdDeviation ( ) const

It gets the standard deviation used in the Standard Deviation grouping.

\output The standard deviation.

◆ getSummary()

std::string te::map::Grouping::getSummary ( ) const

It gets the grouping summary. It is used only in case 1 to n.

◆ getType()

const GroupingType te::map::Grouping::getType ( ) const

It gets the grouping type.

Returns: The grouping type.

◆ isVisible()

bool te::map::Grouping::isVisible ( ) const

It gets the grouping visibility.

◆ setNumSlices()

void te::map::Grouping::setNumSlices ( size_t numSlices )

It sets the number of slices for the EqualSteps and Quantil groupings.

Parameters

numSlices The number of slices.

◆ setPrecision()

void te::map::Grouping::setPrecision ( size_t precision )

It sets the precision to be used for the property values.

Parameters

precision The precision value.

◆ setPropertyName()

void te::map::Grouping::setPropertyName ( const std::string & name )

It sets the property name whose values will be grouped.

Parameters

name	The property name.

◆ setPropertyType()

void te::map::Grouping::setPropertyType ( const int & type )

It sets the property type whose values will be grouped.

Parameters

type	The property type.

◆ setStdDeviation()

void te::map::Grouping::setStdDeviation ( double stdDeviation )

It sets the standard deviation for the Standard Deviation grouping.

Parameters

stdDeviation The standard deviation.

◆ setSummary()

void te::map::Grouping::setSummary ( const std::string & summary )

It gets the grouping summary. It is used only in case 1 to n.

Parameters

summary The summary mode. It can be: "MIN", "MAX", "SUM", "AVERAGE", "MEDIAN", "STDDEV" or "VARIANCE"

◆ setType()

void te::map::Grouping::setType ( GroupingType type )

It sets the grouping type.

Parameters

type	The grouping type.

◆ setVisibility()

void te::map::Grouping::setVisibility ( bool visible )

It sets the grouping visibility.

Parameters

visible The visibility value.

Member Data Documentation

◆ m_isVisible

bool te::map::Grouping::m_isVisible

private

A flag that indicates if the grouping is visible.

Definition at line 191 of file Grouping.h.

◆ m_numSlices

size_t te::map::Grouping::m_numSlices

private

The number of slices used in the Equal Steps and Quantil groupings.

Definition at line 189 of file Grouping.h.

◆ m_precision

size_t te::map::Grouping::m_precision

private

The precision of the values.

Definition at line 188 of file Grouping.h.

◆ m_propertyName

std::string te::map::Grouping::m_propertyName

private

The property name whose values will be used to make the grouping.

Definition at line 185 of file Grouping.h.

◆ m_propertyType

int te::map::Grouping::m_propertyType

private

The property type whose values will be used to make the grouping.

Definition at line 186 of file Grouping.h.

◆ m_stdDeviation

double te::map::Grouping::m_stdDeviation

private

The standard deviation used in the Standard Deviation grouping.

Definition at line 190 of file Grouping.h.

◆ m_summary

std::string te::map::Grouping::m_summary

private

The summary used in case 1 to n.

Definition at line 193 of file Grouping.h.

◆ m_type

GroupingType te::map::Grouping::m_type

private

The grouping type.

Definition at line 187 of file Grouping.h.

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/maptools/Grouping.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Grouping() [1/2]

◆ ~Grouping()

◆ Grouping() [2/2]

Member Function Documentation

◆ clone()

◆ getNumSlices()

◆ getPrecision()

◆ getPropertyName()

◆ getPropertyType()

◆ getStdDeviation()

◆ getSummary()

◆ getType()

◆ isVisible()

◆ setNumSlices()

◆ setPrecision()

◆ setPropertyName()

◆ setPropertyType()

◆ setStdDeviation()

◆ setSummary()

◆ setType()

◆ setVisibility()

Member Data Documentation

◆ m_isVisible

◆ m_numSlices

◆ m_precision

◆ m_propertyName

◆ m_propertyType

◆ m_stdDeviation

◆ m_summary

◆ m_type