te::se::Substring Class Reference

It returns the substring (String formatting functions). More...

#include <Substring.h>

Inheritance diagram for te::se::Substring:

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 Expression *	clone () const =0
	It returns a clone of this object. More...
const std::string &	getFallbackValue () const
void	setFallbackValue (const std::string &v)
void	setLength (ParameterValue *v)
void	setPosition (ParameterValue *v)
void	setStringValue (ParameterValue *v)
Initializer Methods
Methods related to instantiation and destruction.
	Substring ()
	It initializes a new Substring. More...
	~Substring ()
	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.
	Substring (const Substring &rhs)
	No copy constructor allowed. More...
Substring &	operator= (const Substring &rhs)
	No assignment operator allowed. More...

Private Attributes
ParameterValue *	m_length
	Optional. More...
ParameterValue *	m_position
	Optional. More...
ParameterValue *	m_stringValue
	Mandatory. More...

Detailed Description

It returns the substring (String formatting functions).

It returns the substring at position Position (counting from 1) with length Length.
The first argument StringValue is converted to a string value before applying the substring operation. If Position is not specified it is assumed as 1. The default value for Length is the remaining length starting at Position.
The function shall react friendly on invalid Position and Length contents. Positions and Lengths less or equal 0 shall yield the empty string. If the actual string length is less the defined substring the existing part of the substring shall be returned.

See also

Function, ParameterValue

Definition at line 60 of file Substring.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::Substring::Substring

(

)

It initializes a new Substring.

te::se::Substring::~Substring

(

)

Destructor.

te::se::Substring::Substring ( const Substring &  rhs )

private

No copy constructor allowed.

Parameters

rhs	The 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

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

Substring& te::se::Substring::operator= ( const Substring &  rhs )

private

No assignment operator allowed.

Parameters

rhs	The other object.

Returns

A reference for this.

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

inherited

void te::se::Substring::setLength

(

ParameterValue *

v

)

void te::se::Substring::setPosition

(

ParameterValue *

v

)

void te::se::Substring::setStringValue

(

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::Substring::m_length

private

Optional.

Definition at line 110 of file Substring.h.

ParameterValue* te::se::Substring::m_position

private

Optional.

Definition at line 109 of file Substring.h.

ParameterValue* te::se::Substring::m_stringValue

private

Mandatory.

Definition at line 108 of file Substring.h.

---

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

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