te::st::CoverageSeriesIterator Class Reference

A class to traverse the observations of a CoverageSeries. More...

#include <CoverageSeriesIterator.h>

Public Member Functions
	CoverageSeriesIterator ()
	Empty constructor. More...
	CoverageSeriesIterator (const CoverageSeriesObservationSet::const_iterator &it)
	Constructor. More...
te::st::Coverage *	getCoverage () const
	It returns the coverage pointed by the internal cursor. More...
te::dt::DateTime *	getTime () const
	It returns the time pointed by the internal cursor. More...
bool	operator!= (const CoverageSeriesIterator &rhs)
	Operator !=. More...
CoverageSeriesObservation	operator* () const
	Prefix operator *. More...
CoverageSeriesIterator &	operator++ ()
	Prefix operator ++. More...
CoverageSeriesIterator	operator++ (int aux)
	Postfix operator ++. More...
CoverageSeriesIterator &	operator-- ()
	Prefix operator –. More...
CoverageSeriesIterator	operator-- (int aux)
	Postfix operator –. More...
const CoverageSeriesIterator &	operator= (const CoverageSeriesIterator &rhs)
	Assignment operator. More...
bool	operator== (const CoverageSeriesIterator &rhs)
	Operator ==. More...
virtual	~CoverageSeriesIterator ()
	Virtual destructor. More...

Private Attributes
CoverageSeriesObservationSet::const_iterator	m_it
	The internal cursor. More...

Detailed Description

A class to traverse the observations of a CoverageSeries.

This class provides a mechanism to traverse the observations of a CoverageSeries (time and coverage) ordered by time.

An example of use:

CoverageSeriesIterator it = cvs.begin(); while(it!=cvs.end()) { DateTime* t = it.getTime(); Coverage* c = it.getCoverage(); ++it; }

See also

CoverageSeries

Definition at line 70 of file CoverageSeriesIterator.h.

Constructor & Destructor Documentation

te::st::CoverageSeriesIterator::CoverageSeriesIterator

(

)

Empty constructor.

te::st::CoverageSeriesIterator::CoverageSeriesIterator

(

const CoverageSeriesObservationSet::const_iterator &

it

)

Constructor.

Parameters

it	A iterator that points to the point coverage observations

virtual te::st::CoverageSeriesIterator::~CoverageSeriesIterator ( )

virtual

Virtual destructor.

Member Function Documentation

te::st::Coverage* te::st::CoverageSeriesIterator::getCoverage

(

)

const

It returns the coverage pointed by the internal cursor.

Returns

A pointer to the coverage pointed by the internal cursor.

Note

The caller will NOT take the ownership of the returned pointer.

te::dt::DateTime* te::st::CoverageSeriesIterator::getTime

(

)

const

It returns the time pointed by the internal cursor.

Returns

A pointer to the time pointed by the internal cursor.

Note

The caller will NOT take the ownership of the returned pointer.

bool te::st::CoverageSeriesIterator::operator!=

(

const CoverageSeriesIterator &

rhs

)

Operator !=.

CoverageSeriesObservation te::st::CoverageSeriesIterator::operator*

(

)

const

Prefix operator *.

It returns the observation (a pair of shared pointers to DateTime and Coverage) pointed by the internal cursor.

CoverageSeriesIterator& te::st::CoverageSeriesIterator::operator++

(

)

Prefix operator ++.

After using this operator, the internal cursor points to the next coverage series observation.

The semantics of prefix is this: Increment the value and then fetch it.

CoverageSeriesIterator te::st::CoverageSeriesIterator::operator++

(

int

aux

)

Postfix operator ++.

After using this operator, the internal cursor points to the next coverage series observation.

The semantics of postfix is: Fetch the value and then increment the original.

CoverageSeriesIterator& te::st::CoverageSeriesIterator::operator--

(

)

Prefix operator –.

After using this operator, the internal cursor points to the preceding coverage series observation.

The semantics of prefix is this: Increment the value and then fetch it.

CoverageSeriesIterator te::st::CoverageSeriesIterator::operator--

(

int

aux

)

Postfix operator –.

After using this operator, the internal cursor points to the preceding coverage series observation.

The semantics of postfix is: Fetch the value and then increment the original.

const CoverageSeriesIterator& te::st::CoverageSeriesIterator::operator=

(

const CoverageSeriesIterator &

rhs

)

Assignment operator.

bool te::st::CoverageSeriesIterator::operator==

(

const CoverageSeriesIterator &

rhs

)

Operator ==.

Member Data Documentation

CoverageSeriesObservationSet::const_iterator te::st::CoverageSeriesIterator::m_it

private

The internal cursor.

Definition at line 164 of file CoverageSeriesIterator.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/st/core/coverage/CoverageSeriesIterator.h