te::se::FormatNumber Class Referenceabstract

Numeric formatting function. More...

#include <FormatNumber.h>

Inheritance diagram for te::se::FormatNumber:
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...
 
virtual Expressionclone () const =0
 It returns a clone of this object. More...
 
const std::string & getFallbackValue () const
 
void setDecimalPoint (const std::string &dp)
 
void setFallbackValue (const std::string &v)
 
void setGroupingSeparator (const std::string &gs)
 
void setNegativePattern (const std::string &np)
 
void setNumericValue (ParameterValue *v)
 
void setPattern (const std::string &p)
 
Initializer Methods

Methods related to instantiation and destruction.

 FormatNumber ()
 It initializes a new FormatNumber. More...
 
 ~FormatNumber ()
 Destructor. More...
 

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 Member Functions

Not Allowed Methods

No copy allowed.

 FormatNumber (const FormatNumber &rhs)
 No copy constructor allowed. More...
 
FormatNumberoperator= (const FormatNumber &rhs)
 No assignment operator allowed. More...
 

Private Attributes

std::string m_decimalPoint
 Optional. Default: ".". More...
 
std::string m_groupingSeparator
 Optional. Default: ",". More...
 
std::string m_negativePattern
 Optional. More...
 
ParameterValuem_numericValue
 Mandatory. More...
 
std::string m_pattern
 Mandatory. More...
 

Detailed Description

Numeric formatting function.

Function for formatting numbers to make them human readable. One of the most needed is a function for formatting numbers to make them human readable. You need such a function whenever a TextSymbolizer is employed to output a numeric property value.

See also
Function, ParameterValue

Definition at line 52 of file FormatNumber.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::FormatNumber::FormatNumber ( )

It initializes a new FormatNumber.

te::se::FormatNumber::~FormatNumber ( )

Destructor.

te::se::FormatNumber::FormatNumber ( const FormatNumber rhs)
private

No copy constructor allowed.

Parameters
rhsThe other object.

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.
virtual Expression* te::fe::Expression::clone ( ) const
pure virtualinherited
const std::string& te::se::Function::getFallbackValue ( ) const
inherited
FormatNumber& te::se::FormatNumber::operator= ( const FormatNumber rhs)
private

No assignment operator allowed.

Parameters
rhsThe other object.
Returns
A reference for this.
void te::se::FormatNumber::setDecimalPoint ( const std::string &  dp)
void te::se::Function::setFallbackValue ( const std::string &  v)
inherited
void te::se::FormatNumber::setGroupingSeparator ( const std::string &  gs)
void te::se::FormatNumber::setNegativePattern ( const std::string &  np)
void te::se::FormatNumber::setNumericValue ( ParameterValue v)
void te::se::FormatNumber::setPattern ( const std::string &  p)

Member Data Documentation

std::string te::se::FormatNumber::m_decimalPoint
private

Optional. Default: ".".

Definition at line 125 of file FormatNumber.h.

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.

std::string te::se::FormatNumber::m_groupingSeparator
private

Optional. Default: ",".

Definition at line 126 of file FormatNumber.h.

std::string te::se::FormatNumber::m_negativePattern
private

Optional.

Definition at line 124 of file FormatNumber.h.

ParameterValue* te::se::FormatNumber::m_numericValue
private

Mandatory.

Definition at line 122 of file FormatNumber.h.

std::string te::se::FormatNumber::m_pattern
private

Mandatory.

Definition at line 123 of file FormatNumber.h.


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