te::fe::SortProperty Class Reference

A sort property name and order type. More...

#include <SortProperty.h>

Public Types
enum	SortOrder { DESC, ASC }
	Sort order type: asc or desc. More...

Public Member Functions
Initializer Methods
Methods related to instantiation and destruction.
	SortProperty ()
	It initializes a new SortProperty. More...
	~SortProperty ()
	Destructor. More...
Accessor methods
Methods used to get or set properties.
void	setPropertyName (PropertyName *p)
	It sets the property name. More...
const PropertyName *	getPropertyName () const
	It returns the property name. More...
void	setSortOrder (SortOrder direction)
	It sets the sort order. More...
SortOrder	getSortOrder () const
	It return the associated sort order. More...

Private Attributes
PropertyName *	m_property
	Mandatory. More...
SortOrder	m_sortOrder
	Optional. More...

Detailed Description

A sort property name and order type.

The order default will be ascendent if none is informed.

See also

SortBy, PropertyName

Definition at line 48 of file SortProperty.h.

Member Enumeration Documentation

enum te::fe::SortProperty::SortOrder

Sort order type: asc or desc.

Enumerator
DESC	Descendent order type.
ASC	Ascendent order type.

Definition at line 57 of file SortProperty.h.

Constructor & Destructor Documentation

te::fe::SortProperty::SortProperty

(

)

It initializes a new SortProperty.

Definition at line 30 of file SortProperty.cpp.

te::fe::SortProperty::~SortProperty

(

)

Destructor.

Definition at line 36 of file SortProperty.cpp.

Member Function Documentation

const te::fe::PropertyName * te::fe::SortProperty::getPropertyName

(

)

const

It returns the property name.

Returns

The property name.

Definition at line 47 of file SortProperty.cpp.

te::fe::SortProperty::SortOrder te::fe::SortProperty::getSortOrder

(

)

const

It return the associated sort order.

Returns

The associated sort order.

Definition at line 57 of file SortProperty.cpp.

void te::fe::SortProperty::setPropertyName

(

PropertyName *

p

)

It sets the property name.

Parameters

p	The property name. The SortProperty will take the ownership of the property name.

Note

The previous property is discarted.

Definition at line 41 of file SortProperty.cpp.

void te::fe::SortProperty::setSortOrder

(

SortProperty::SortOrder

direction

)

It sets the sort order.

Parameters

direction

Sort order direction (ASC or DESC).

Definition at line 52 of file SortProperty.cpp.

Member Data Documentation

PropertyName* te::fe::SortProperty::m_property

private

Mandatory.

Definition at line 115 of file SortProperty.h.

SortOrder te::fe::SortProperty::m_sortOrder

private

Optional.

Definition at line 116 of file SortProperty.h.

---

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

• C:/TL5_2015_release/terralib5/src/terralib/fe/SortProperty.h
• C:/TL5_2015_release/terralib5/src/terralib/fe/SortProperty.cpp