Public Member Functions | List of all members
te::rp::AbstractFeeder< ObjType > Class Template Referenceabstract

Abstract objects feeder. More...

#include <AbstractFeeder.h>

Inheritance diagram for te::rp::AbstractFeeder< ObjType >:

Public Member Functions

 AbstractFeeder ()
 
virtual ObjType * 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 ~AbstractFeeder ()
 

Detailed Description

template<typename ObjType>
class te::rp::AbstractFeeder< ObjType >

Abstract objects feeder.

Sequential objects feeder to image processing algorithms.

Definition at line 42 of file AbstractFeeder.h.

Constructor & Destructor Documentation

◆ AbstractFeeder()

template<typename ObjType >
te::rp::AbstractFeeder< ObjType >::AbstractFeeder ( )
inline

Definition at line 46 of file AbstractFeeder.h.

◆ ~AbstractFeeder()

template<typename ObjType >
virtual te::rp::AbstractFeeder< ObjType >::~AbstractFeeder ( )
inlinevirtual

Definition at line 48 of file AbstractFeeder.h.

Member Function Documentation

◆ getCurrentObj()

template<typename ObjType >
virtual ObjType* te::rp::AbstractFeeder< ObjType >::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.

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

◆ getCurrentOffset()

template<typename ObjType >
virtual unsigned int te::rp::AbstractFeeder< ObjType >::getCurrentOffset ( ) const
pure virtual

Return the index of the current object.

Returns
The index of the current object.

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

◆ getObjsCount()

template<typename ObjType >
virtual unsigned int te::rp::AbstractFeeder< ObjType >::getObjsCount ( ) const
pure virtual

Return the total number of feeder objects.

Returns
The total number of feeder objects.

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

◆ moveNext()

template<typename ObjType >
virtual bool te::rp::AbstractFeeder< ObjType >::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.

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

◆ moveTo()

template<typename ObjType >
virtual bool te::rp::AbstractFeeder< ObjType >::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.

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

◆ reset()

template<typename ObjType >
virtual void te::rp::AbstractFeeder< ObjType >::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.

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

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