All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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...
 
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 67 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.

Definition at line 37 of file FeedersRaster.cpp.

te::rp::FeederConstRasterVector::~FeederConstRasterVector ( )

Definition at line 48 of file FeedersRaster.cpp.

te::rp::FeederConstRasterVector::FeederConstRasterVector ( )
protected

Definition at line 43 of file FeedersRaster.cpp.

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.

Definition at line 52 of file FeedersRaster.cpp.

References m_currentOffset, and m_rasters.

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.

Definition at line 81 of file FeedersRaster.cpp.

References m_currentOffset.

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.

Definition at line 76 of file FeedersRaster.cpp.

References m_rasters.

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.

Definition at line 58 of file FeedersRaster.cpp.

References m_currentOffset, and m_rasters.

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.

Definition at line 71 of file FeedersRaster.cpp.

References m_currentOffset.

Member Data Documentation

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

Definition at line 90 of file FeedersRaster.h.

Referenced by getCurrentObj(), getCurrentOffset(), moveNext(), and reset().

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

Definition at line 91 of file FeedersRaster.h.

Referenced by getCurrentObj(), getObjsCount(), and moveNext().


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