MeVisLab Toolbox Reference
Public Member Functions | List of all members
ml::RasterFunctionList Class Reference

Base object class to handle a list of raster functions. More...

#include <mlRasterFunctionList.h>

Inheritance diagram for ml::RasterFunctionList:
ml::Base

Public Member Functions

 RasterFunctionList ()
 Constructor. It does nothing, i.e. an empty list is created.
 
 ~RasterFunctionList () override
 Destructor. It removes all handled raster functions and the list.
 
virtual size_t getListSize ()
 Permits access to the list of raster functions.
 
virtual void setListElement (size_t idx, const RasterFunction &elem)
 Permits access to the list of raster functions.
 
virtual void appendToList (const RasterFunction &elem)
 Permits access to the list of raster functions.
 
virtual const RasterFunction & getListElement (size_t idx)
 Permits access to the list of raster functions.
 
std::string persistentState () const override
 Persistence support. Still unimplemented, only for later usage.
 
void setPersistentState (const std::string &) override
 Restores the object's internal state from a string that had been previously generated using persistentState().
 
RasterFunction * getPtr (MLssize_t index=-1)
 Returns pointer to the RasterFunction at given index index.
 
void setValue (MLssize_t index, const RasterFunction &obj)
 Sets new raster function obj at index index, index -1 sets the last element.
 
void removeValue (MLssize_t index=-1)
 Remove RasterFunction from list. If index is -1 the last element is removed.
 
void clear ()
 Clears the inner list.
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
 
virtual ~Base ()
 Destructor.
 
virtual Base * deepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion()
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument.
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase.
 
virtual std::string detailString () const
 Return a string describing this object.
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class.
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object.
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object.
 

Additional Inherited Members

- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 

Detailed Description

Base object class to handle a list of raster functions.

Definition at line 34 of file mlRasterFunctionList.h.

Constructor & Destructor Documentation

◆ RasterFunctionList()

ml::RasterFunctionList::RasterFunctionList ( )
inline

Constructor. It does nothing, i.e. an empty list is created.

Definition at line 38 of file mlRasterFunctionList.h.

◆ ~RasterFunctionList()

ml::RasterFunctionList::~RasterFunctionList ( )
inlineoverride

Destructor. It removes all handled raster functions and the list.

Definition at line 41 of file mlRasterFunctionList.h.

Member Function Documentation

◆ appendToList()

virtual void ml::RasterFunctionList::appendToList ( const RasterFunction & elem)
inlinevirtual

Permits access to the list of raster functions.

Definition at line 55 of file mlRasterFunctionList.h.

References mlrange_cast().

◆ clear()

void ml::RasterFunctionList::clear ( )

Clears the inner list.

◆ getListElement()

virtual const RasterFunction & ml::RasterFunctionList::getListElement ( size_t idx)
inlinevirtual

Permits access to the list of raster functions.

Definition at line 59 of file mlRasterFunctionList.h.

References mlrange_cast().

◆ getListSize()

virtual size_t ml::RasterFunctionList::getListSize ( )
inlinevirtual

Permits access to the list of raster functions.

Permits access to the list of raster functions.

Definition at line 47 of file mlRasterFunctionList.h.

◆ getPtr()

RasterFunction * ml::RasterFunctionList::getPtr ( MLssize_t index = -1)

Returns pointer to the RasterFunction at given index index.

On index -1 the last element is returned and on invalid indexes NULL is returned.

◆ persistentState()

std::string ml::RasterFunctionList::persistentState ( ) const
inlineoverridevirtual

Persistence support. Still unimplemented, only for later usage.

Reimplemented from ml::Base.

Definition at line 63 of file mlRasterFunctionList.h.

◆ removeValue()

void ml::RasterFunctionList::removeValue ( MLssize_t index = -1)

Remove RasterFunction from list. If index is -1 the last element is removed.

◆ setListElement()

virtual void ml::RasterFunctionList::setListElement ( size_t idx,
const RasterFunction & elem )
inlinevirtual

Permits access to the list of raster functions.

Definition at line 51 of file mlRasterFunctionList.h.

References mlrange_cast().

◆ setPersistentState()

void ml::RasterFunctionList::setPersistentState ( const std::string & state)
inlineoverridevirtual

Restores the object's internal state from a string that had been previously generated using persistentState().

Reimplemented from ml::Base.

Definition at line 65 of file mlRasterFunctionList.h.

◆ setValue()

void ml::RasterFunctionList::setValue ( MLssize_t index,
const RasterFunction & obj )

Sets new raster function obj at index index, index -1 sets the last element.

On index == -1 and on empty lists, one element is inserted.

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