All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::map::Grouping Class Reference

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

#include <Grouping.h>

Public Member Functions

const std::vector
< te::map::GroupingItem * > & 
getGroupingItems () const
 It gets the vector of grouping items. More...
 
const size_t getNumSlices () const
 It gets the number of slices used in the Equal Steps and Quantil groupings. More...
 
const size_t getPrecision () const
 It gets the precision used for the property values. More...
 
std::string getPropertyName () const
 It gets the property name whose values will be grouped. More...
 
int getPropertyType () const
 It gets the property type whose values will be grouped. More...
 
const double getStdDeviation () const
 It gets the standard deviation used in the Standard Deviation grouping. More...
 
const GroupingType getType () const
 It gets the grouping type. More...
 
 Grouping (const std::string &propertyName, GroupingType type, size_t precision=6)
 It constructs a new Grouping instance. More...
 
 Grouping (const Grouping &rhs)
 Copy constructor. More...
 
bool isVisible () const
 It gets the grouping visibility. More...
 
void setGroupingItems (std::vector< te::map::GroupingItem * > &items)
 It sets the vector of grouping items. More...
 
void setNumSlices (size_t numSlices)
 It sets the number of slices for the EqualSteps and Quantil groupings. More...
 
void setPrecision (size_t precision)
 It sets the precision to be used for the property values. More...
 
void setPropertyName (const std::string &name)
 It sets the property name whose values will be grouped. More...
 
void setPropertyType (const int &type)
 It sets the property type whose values will be grouped. More...
 
void setStdDeviation (double stdDeviation)
 It sets the standard deviation for the Standard Deviation grouping. More...
 
void setType (GroupingType type)
 It sets the grouping type. More...
 
void setVisibility (bool visible)
 It sets the grouping visibility. More...
 
 ~Grouping ()
 Destructor. More...
 

Private Attributes

bool m_isVisible
 A flag that indicates if the grouping is visible. More...
 
std::vector
< te::map::GroupingItem * > 
m_items
 The vector of grouping items. More...
 
size_t m_numSlices
 The number of slices used in the Equal Steps and Quantil groupings. More...
 
size_t m_precision
 The precision of the values. More...
 
std::string m_propertyName
 The property name whose values will be used to make the grouping. More...
 
int m_propertyType
 The property type whose values will be used to make the grouping. More...
 
double m_stdDeviation
 The standard deviation used in the Standard Deviation grouping. More...
 
GroupingType m_type
 The grouping type. More...
 

Detailed Description

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

See also
GroupingItem, Layer

Definition at line 59 of file Grouping.h.

Constructor & Destructor Documentation

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

It constructs a new Grouping instance.

Parameters
propertyNameThe property name whose values will be used to make the grouping.
typeThe grouping type.
precisionThe precision to be set to the property values.

Definition at line 33 of file Grouping.cpp.

References m_propertyType, and te::dt::UNKNOWN_TYPE.

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

Destructor.

Definition at line 61 of file Grouping.cpp.

References te::common::FreeContents().

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

Copy constructor.

Definition at line 42 of file Grouping.cpp.

References m_items, m_numSlices, m_stdDeviation, setGroupingItems(), setNumSlices(), and setStdDeviation().

Member Function Documentation

const std::vector< te::map::GroupingItem * > & te::map::Grouping::getGroupingItems ( ) const
const size_t te::map::Grouping::getNumSlices ( ) const

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

The number of slices.

Definition at line 108 of file Grouping.cpp.

Referenced by te::qt::widgets::GroupingWidget::setGrouping().

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

It gets the precision used for the property values.

The precision used for the property values.

Definition at line 98 of file Grouping.cpp.

Referenced by te::map::AbstractLayerRenderer::drawLayerGroupingMem(), te::qt::widgets::GroupingWidget::setGrouping(), and WriteLayerGrouping().

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

It gets the property type whose values will be grouped.

Returns
The property type.

Definition at line 77 of file Grouping.cpp.

Referenced by te::map::DataSetLayerRenderer::drawGrouping(), te::map::AbstractLayerRenderer::drawLayerGrouping(), and WriteLayerGrouping().

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

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

The standard deviation.

Definition at line 118 of file Grouping.cpp.

Referenced by te::qt::widgets::GroupingWidget::setGrouping(), and WriteLayerGrouping().

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

It gets the grouping visibility.

Definition at line 140 of file Grouping.cpp.

Referenced by te::map::DataSetLayerRenderer::draw(), and te::map::AbstractLayerRenderer::draw().

void te::map::Grouping::setGroupingItems ( std::vector< te::map::GroupingItem * > &  items)

It sets the vector of grouping items.

Parameters
Thevector of grouping items.

Definition at line 133 of file Grouping.cpp.

Referenced by te::qt::plugins::terralib4::GetGrouping(), and Grouping().

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

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

Parameters
numSlicesThe number of slices.

Definition at line 113 of file Grouping.cpp.

Referenced by Grouping().

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

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

Parameters
precisionThe precision value.

Definition at line 103 of file Grouping.cpp.

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

It sets the property name whose values will be grouped.

Parameters
nameThe property name.

Definition at line 72 of file Grouping.cpp.

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

It sets the property type whose values will be grouped.

Parameters
typeThe property type.

Definition at line 82 of file Grouping.cpp.

Referenced by te::qt::plugins::terralib4::GetGrouping().

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

It sets the standard deviation for the Standard Deviation grouping.

Parameters
stdDeviationThe standard deviation.

Definition at line 123 of file Grouping.cpp.

Referenced by te::qt::plugins::terralib4::GetGrouping(), and Grouping().

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

It sets the grouping type.

Parameters
typeThe grouping type.

Definition at line 93 of file Grouping.cpp.

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

It sets the grouping visibility.

Parameters
visibleThe visibility value.

Definition at line 145 of file Grouping.cpp.

Member Data Documentation

bool te::map::Grouping::m_isVisible
private

A flag that indicates if the grouping is visible.

Definition at line 194 of file Grouping.h.

std::vector<te::map::GroupingItem*> te::map::Grouping::m_items
private

The vector of grouping items.

Definition at line 195 of file Grouping.h.

Referenced by Grouping().

size_t te::map::Grouping::m_numSlices
private

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

Definition at line 192 of file Grouping.h.

Referenced by Grouping().

size_t te::map::Grouping::m_precision
private

The precision of the values.

Definition at line 191 of file Grouping.h.

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

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

Definition at line 188 of file Grouping.h.

int te::map::Grouping::m_propertyType
private

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

Definition at line 189 of file Grouping.h.

Referenced by Grouping().

double te::map::Grouping::m_stdDeviation
private

The standard deviation used in the Standard Deviation grouping.

Definition at line 193 of file Grouping.h.

Referenced by Grouping().

GroupingType te::map::Grouping::m_type
private

The grouping type.

Definition at line 190 of file Grouping.h.


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