Public Member Functions | Protected Member Functions | List of all members
te::rp::FeederConstRaster Class Referenceabstract

Feeder from a input rasters. More...

#include <FeedersRaster.h>

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

Public Member Functions

virtual te::rst::Raster const * getCurrentObj () const =0
 Return the current sequence object. More...
 
virtual unsigned int getCurrentOffset () const =0
 Return the index of the current object. More...
 
virtual unsigned int getObjsCount () const =0
 Return the total number of feeder objects. More...
 
virtual bool moveNext ()=0
 Advances to the next sequence obeject. More...
 
virtual bool moveTo (const unsigned int index)=0
 Jump to the given object index. More...
 
virtual void reset ()=0
 Reset the feeder to the first position (subsequent accesses will start from the first sequence obejct). More...
 
virtual ~FeederConstRaster ()
 

Protected Member Functions

 FeederConstRaster ()
 

Detailed Description

Feeder from a input rasters.

Definition at line 46 of file FeedersRaster.h.

Constructor & Destructor Documentation

◆ ~FeederConstRaster()

virtual te::rp::FeederConstRaster::~FeederConstRaster ( )
inlinevirtual

Definition at line 50 of file FeedersRaster.h.

◆ FeederConstRaster()

te::rp::FeederConstRaster::FeederConstRaster ( )
inlineprotected

Definition at line 62 of file FeedersRaster.h.

Member Function Documentation

◆ getCurrentObj()

virtual te::rst::Raster const* te::rp::FeederConstRaster::getCurrentObj ( ) const
pure 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::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

◆ getCurrentOffset()

virtual unsigned int te::rp::FeederConstRaster::getCurrentOffset ( ) const
pure virtual

Return the index of the current object.

Returns
The index of the current object.

Implements te::rp::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

◆ getObjsCount()

virtual unsigned int te::rp::FeederConstRaster::getObjsCount ( ) const
pure virtual

Return the total number of feeder objects.

Returns
The total number of feeder objects.

Implements te::rp::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

◆ moveNext()

virtual bool te::rp::FeederConstRaster::moveNext ( )
pure 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::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

◆ moveTo()

virtual bool te::rp::FeederConstRaster::moveTo ( const unsigned int  index)
pure 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::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

◆ reset()

virtual void te::rp::FeederConstRaster::reset ( )
pure 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::AbstractFeeder< const te::rst::Raster >.

Implemented in te::rp::FeederConstRasterDirectory, te::rp::FeederConstRasterInfoAndVector, te::rp::FeederConstRasterInfo, and te::rp::FeederConstRasterVector.

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