All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::se::Trim Class Referenceabstract

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

#include <Trim.h>

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

Public Types

typedef R 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 Expressionclone () 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

ParameterValuem_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 R te::common::BaseVisitable< Visitor , R >::ReturnType
inherited

Definition at line 58 of file BaseVisitable.h.

Definition at line 57 of file BaseVisitable.h.

Member Enumeration Documentation

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.

Definition at line 30 of file Trim.cpp.

te::se::Trim::~Trim ( )

Destructor.

Definition at line 36 of file Trim.cpp.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< Visitor , R >::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
void te::se::Trim::setStringValue ( ParameterValue v)

Definition at line 41 of file Trim.cpp.

void te::se::Trim::setStripOffChar ( const std::string &  v)

Definition at line 52 of file Trim.cpp.

void te::se::Trim::setStripOffPosition ( StripOffPositionType  p)

Definition at line 47 of file Trim.cpp.

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.

Referenced by te::se::Categorize::Categorize(), and te::se::Interpolate::Interpolate().

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 files: