te::fe::SortBy Class Reference

It represents a sort by expression. More...

#include <SortBy.h>

Public Member Functions

Initializer Methods

Methods related to instantiation and destruction.

 SortBy ()
 It initializes a new SortBy. More...
 
 ~SortBy ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

std::size_t size () const
 It returns the number of sort expressions. More...
 
void push_back (SortProperty *p)
 It adds the property to the sort list. More...
 
const SortPropertyoperator[] (std::size_t index) const
 It returns a specified property. More...
 

Private Attributes

std::vector< SortProperty * > m_sortPropertyVector
 Mandatory at least one sort property. More...
 

Detailed Description

It represents a sort by expression.

See also
SortProperty

Definition at line 49 of file SortBy.h.

Constructor & Destructor Documentation

te::fe::SortBy::SortBy ( )

It initializes a new SortBy.

te::fe::SortBy::~SortBy ( )

Destructor.

Member Function Documentation

const SortProperty* te::fe::SortBy::operator[] ( std::size_t  index) const

It returns a specified property.

Parameters
indexThe index of desired property.
Returns
A specified property.
Note
You must not clear the returned property.
The method will not check the index range.
void te::fe::SortBy::push_back ( SortProperty p)

It adds the property to the sort list.

Parameters
pThe property to be added to the sort list.
Note
The SortBy object will take the ownership of the property. So, you must not free it.
std::size_t te::fe::SortBy::size ( ) const

It returns the number of sort expressions.

Returns
The number of sort expressions.

Member Data Documentation

std::vector<SortProperty*> te::fe::SortBy::m_sortPropertyVector
private

Mandatory at least one sort property.

Definition at line 104 of file SortBy.h.


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