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 SortProperty *	operator[] (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 ( )

default

It initializes a new SortBy.

te::fe::SortBy::~SortBy

(

)

Destructor.

Definition at line 36 of file SortBy.cpp.

References te::common::FreeContents(), and m_sortPropertyVector.

Member Function Documentation

const te::fe::SortProperty * te::fe::SortBy::operator[]

(

std::size_t

index

)

const

It returns a specified property.

Parameters

index

The index of desired property.

Returns

A specified property.

Note

You must not clear the returned property.

The method will not check the index range.

Definition at line 51 of file SortBy.cpp.

References m_sortPropertyVector.

void te::fe::SortBy::push_back

(

SortProperty *

p

)

It adds the property to the sort list.

Parameters

p	The 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.

Definition at line 46 of file SortBy.cpp.

References m_sortPropertyVector.

std::size_t te::fe::SortBy::size

(

)

const

It returns the number of sort expressions.

Returns

The number of sort expressions.

Definition at line 41 of file SortBy.cpp.

References m_sortPropertyVector.

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.

Referenced by operator[](), push_back(), size(), and ~SortBy().

---

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

• SortBy.h
• SortBy.cpp