te::se::FormatDate Class Reference

Date formatting function. More...

#include <FormatDate.h>

Inheritance diagram for te::se::FormatDate:

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	setDateValue (ParameterValue *v)
void	setFallbackValue (const std::string &v)
void	setPattern (const std::string &p)
Initializer Methods
Methods related to instantiation and destruction.
	FormatDate ()
	It initializes a new FormatDate. More...
	~FormatDate ()
	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.
	FormatDate (const FormatDate &rhs)
	No copy constructor allowed. More...
FormatDate &	operator= (const FormatDate &rhs)
	No assignment operator allowed. More...

Private Attributes
ParameterValue *	m_dateValue
	Mandatory. More...
std::string	m_pattern
	Mandatory. More...

Detailed Description

Date formatting function.

Function for dates. This function is used for several date types. The argument of the function can consist of one of the following ISO 8601 XML schema types:

• dateTime
• time
• date
• gYearMonth
• gMonthDay
• gDay
• gMonth
• gYear
• gml:TimeInstant

Standard output is as defined in ISO 8601: YYYY-MM-DDThh:mm:ss.

See also

Function, ParameterValue

Definition at line 63 of file FormatDate.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::FormatDate::FormatDate

(

)

It initializes a new FormatDate.

te::se::FormatDate::~FormatDate

(

)

Destructor.

te::se::FormatDate::FormatDate ( const FormatDate &  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

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

private

No assignment operator allowed.

Parameters

rhs	The other object.

Returns

A reference for this.

void te::se::FormatDate::setDateValue

(

ParameterValue *

v

)

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

inherited

void te::se::FormatDate::setPattern

(

const std::string &

p

)

Member Data Documentation

ParameterValue* te::se::FormatDate::m_dateValue

private

Mandatory.

Definition at line 139 of file FormatDate.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::FormatDate::m_pattern

private

Mandatory.

Definition at line 140 of file FormatDate.h.

---

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

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