te::se::Trim Class Reference

Strips off chars from a string value (String formatting functions). More...

#include <Trim.h>

Inheritance diagram for te::se::Trim:

Public Types
typedef void	ReturnType
enum	StripOffPositionType { LEADING, TRAILING, BOTH }
	It controls the mode of stripping characters. More...
typedef Visitor	VisitorType

Public Member Functions
virtual ReturnType	accept (VisitorType &guest) const =0
	It call the visit method from the guest object. More...
virtual Expression *	clone () const =0
	It returns a clone of this object. More...
const std::string &	getFallbackValue () const
void	setFallbackValue (const std::string &v)
void	setStringValue (ParameterValue *v)
void	setStripOffChar (const std::string &v)
void	setStripOffPosition (StripOffPositionType p)
Initializer Methods
Methods related to instantiation and destruction.
	Trim ()
	It initializes a new Trim. More...
	~Trim ()
	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 Attributes
ParameterValue *	m_stringValue
	Mandatory. More...
std::string	m_stripOffChar
	Mandatory. More...
StripOffPositionType	m_stripOffPosition
	Mandatory. More...

Detailed Description

Strips off chars from a string value (String formatting functions).

The function strips off "leading", "trailing", or "both" chars from a string value. Attributes control the mode of stripping and the character stripped. Defaults are "leading" and blank.

See also

Function, ParameterValue, StringLength, StringPosition

Definition at line 51 of file Trim.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.

Member Enumeration Documentation

enum te::se::Trim::StripOffPositionType

It controls the mode of stripping characters.

Enumerator
LEADING	It means to strips off leading chars from a string value.
TRAILING	It means to strips off trailing chars from a string value.
BOTH	It means to strips off both (leading and trailing) chars from a string value.

Definition at line 60 of file Trim.h.

Constructor & Destructor Documentation

te::se::Trim::Trim

(

)

It initializes a new Trim.

te::se::Trim::~Trim

(

)

Destructor.

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

guest

The guest or visitor.

Returns

Any valid value define by the template type R.

virtual Expression* te::fe::Expression::clone ( ) const

pure virtualinherited

It returns a clone of this object.

Returns

A clone of this object.

Implemented in te::fe::BinaryOperator, te::fe::Function, te::se::Interpolate, te::se::Categorize, te::fe::Literal, te::fe::PropertyName, te::se::Recode, te::se::InterpolationPoint, and te::se::MapItem.

const std::string& te::se::Function::getFallbackValue ( ) const

inherited

void te::se::Function::setFallbackValue ( const std::string &  v )

inherited

void te::se::Trim::setStringValue

(

ParameterValue *

v

)

void te::se::Trim::setStripOffChar

(

const std::string &

v

)

void te::se::Trim::setStripOffPosition

(

StripOffPositionType

p

)

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::Trim::m_stringValue

private

Mandatory.

Definition at line 86 of file Trim.h.

std::string te::se::Trim::m_stripOffChar

private

Mandatory.

Definition at line 88 of file Trim.h.

StripOffPositionType te::se::Trim::m_stripOffPosition

private

Mandatory.

Definition at line 87 of file Trim.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/se/Trim.h