te::rp::FeederConstRasterVector Class Reference

A feeder from a input rasters vector;. More...

#include <FeedersRaster.h>

Inheritance diagram for te::rp::FeederConstRasterVector:
te::rp::FeederConstRaster te::rp::AbstractFeeder< const te::rst::Raster >

Public Member Functions

 FeederConstRasterVector (const std::vector< const te::rst::Raster * > rasters)
 Constructor from a vector of input rasters pointers;. More...
 
te::rst::Raster const * getCurrentObj () const
 Return the current sequence object. More...
 
unsigned int getCurrentOffset () const
 Return the index of the current object. More...
 
unsigned int getObjsCount () const
 Return the total number of feeder objects. More...
 
bool moveNext ()
 Advances to the next sequence obeject. More...
 
bool moveTo (const unsigned int index)
 Jump to the given object index. More...
 
void reset ()
 Reset the feeder to the first position (subsequent accesses will start from the first sequence obejct). More...
 
 ~FeederConstRasterVector ()
 

Protected Member Functions

 FeederConstRasterVector ()
 

Protected Attributes

std::vector< const te::rst::Raster * >::size_type m_currentOffset
 
std::vector< const te::rst::Raster * > m_rasters
 

Detailed Description

A feeder from a input rasters vector;.

Definition at line 69 of file FeedersRaster.h.

Constructor & Destructor Documentation

te::rp::FeederConstRasterVector::FeederConstRasterVector ( const std::vector< const te::rst::Raster * >  rasters)

Constructor from a vector of input rasters pointers;.

Parameters
rastersInput vector of rasters pointers.
Note
The given rasters must always be avaliable.
The feeder WILL NOT ACQUIRE the pointers.
te::rp::FeederConstRasterVector::~FeederConstRasterVector ( )
te::rp::FeederConstRasterVector::FeederConstRasterVector ( )
protected

Member Function Documentation

te::rst::Raster const* te::rp::FeederConstRasterVector::getCurrentObj ( ) const
virtual

Return the current sequence object.

Returns
A pointer to the current object or a null pointer if there are no object to return.

Implements te::rp::FeederConstRaster.

unsigned int te::rp::FeederConstRasterVector::getCurrentOffset ( ) const
virtual

Return the index of the current object.

Returns
The index of the current object.

Implements te::rp::FeederConstRaster.

unsigned int te::rp::FeederConstRasterVector::getObjsCount ( ) const
virtual

Return the total number of feeder objects.

Returns
The total number of feeder objects.

Implements te::rp::FeederConstRaster.

bool te::rp::FeederConstRasterVector::moveNext ( )
virtual

Advances to the next sequence obeject.

Returns
true if the advance was completed or false if the objects sequence end was reached.
Note
This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

bool te::rp::FeederConstRasterVector::moveTo ( const unsigned int  index)
virtual

Jump to the given object index.

Returns
true if the jump was completed or false on errors.
Note
This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

void te::rp::FeederConstRasterVector::reset ( )
virtual

Reset the feeder to the first position (subsequent accesses will start from the first sequence obejct).

Note
This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

Member Data Documentation

std::vector< const te::rst::Raster* >::size_type te::rp::FeederConstRasterVector::m_currentOffset
protected

Definition at line 93 of file FeedersRaster.h.

std::vector< const te::rst::Raster* > te::rp::FeederConstRasterVector::m_rasters
protected

Definition at line 94 of file FeedersRaster.h.


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