te::se::Recode Class Referenceabstract

Transformation of discrete values to other values. More...

#include <Recode.h>

Inheritance diagram for te::se::Recode:
te::se::Function te::fe::Expression te::common::BaseVisitable< Visitor >

Public Types

typedef void ReturnType
 
typedef Visitor VisitorType
 

Public Member Functions

virtual ReturnType accept (VisitorType &guest) const =0
 It call the visit method from the guest object. More...
 
const std::string & getFallbackValue () const
 
void setFallbackValue (const std::string &v)
 
Initializer Methods

Methods related to instantiation and destruction.

 Recode ()
 It initializes a new Recode. More...
 
 ~Recode ()
 Destructor. More...
 
 Recode (const Recode &rhs)
 Copy constructor. More...
 
virtual Recodeclone () const
 It returns a clone of this object. More...
 
void setLookupValue (ParameterValue *v)
 
void add (MapItem *m)
 
std::vector< MapItem * > getMapItems () const
 

Protected Attributes

std::string m_fallbackValue
 The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function. (Mandatory) More...
 

Private Attributes

ParameterValuem_lookupValue
 Mandatory. More...
 
std::vector< MapItem * > m_mapItems
 Mandatory. More...
 

Detailed Description

Transformation of discrete values to other values.

The Symbology encoding specification defines three pre-defined functions for transforming raw data:

  • Categorization: The transformation of continuous values to distinct values. This is for example needed to generate choropleth maps from continuous attributes. Another example would be the stepwise selection of different text heights or line widths in dependence from such an attribute;
  • Interpolation: Transformation of continuous values by a function defined on a number of nodes. This is used to adjust the value distribution of an attribute to the desired distribution of a continuous symbolization control variable (like size, width, color, etc);
  • Recoding: Transformation of discrete values to any other values. This is needed when integers have to be translated into text or, reversely, text contents into other texts or numeric values or colors.


It allows to replace a color in the ExternalGraphic, the color specified in the OriginalColor sub-element, by another color as a result of a recode function.

See also
Function, ExternalGraphic, MapItem, ParameterValue

Definition at line 75 of file Recode.h.

Member Typedef Documentation

typedef void te::common::BaseVisitable< Visitor , void >::ReturnType
inherited

Definition at line 58 of file BaseVisitable.h.

typedef Visitor te::common::BaseVisitable< Visitor , void >::VisitorType
inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

te::se::Recode::Recode ( )

It initializes a new Recode.

te::se::Recode::~Recode ( )

Destructor.

te::se::Recode::Recode ( const Recode rhs)

Copy constructor.

Parameters
rhsThe other Categorize.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< Visitor , void >::accept ( VisitorType guest) const
pure virtualinherited

It call the visit method from the guest object.

Parameters
guestThe guest or visitor.
Returns
Any valid value define by the template type R.
void te::se::Recode::add ( MapItem m)
virtual Recode* te::se::Recode::clone ( ) const
virtual

It returns a clone of this object.

Returns
A clone of this object.

Implements te::fe::Expression.

const std::string& te::se::Function::getFallbackValue ( ) const
inherited
std::vector<MapItem*> te::se::Recode::getMapItems ( ) const
void te::se::Function::setFallbackValue ( const std::string &  v)
inherited
void te::se::Recode::setLookupValue ( ParameterValue v)

Member Data Documentation

std::string te::se::Function::m_fallbackValue
protectedinherited

The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function. (Mandatory)

Definition at line 88 of file Function.h.

ParameterValue* te::se::Recode::m_lookupValue
private

Mandatory.

Definition at line 120 of file Recode.h.

std::vector<MapItem*> te::se::Recode::m_mapItems
private

Mandatory.

Definition at line 121 of file Recode.h.


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