MeVisLabToolboxReference
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

List of all members.

Public Member Functions

 RasterFunctionList ()
 Constructor. It does nothing, i.e. an empty list is created.
virtual ~RasterFunctionList ()
 Destructor. It removes all handled raster functions and the list.
virtual size_t getListSize ()
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 RasterFunctiongetListElement (size_t idx)
 Permits access to the list of raster functions.
virtual char * getPersistentState () const
 Persistence support. Still unimplemented, only for later usage.
virtual void setPersistentState (const char *)
 Persistence support. Still unimplemented, only for later usage.
virtual void clearPersistentState (char *) const
 Persistence support. Still unimplemented, only for later usage.
RasterFunctiongetPtr (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.

Detailed Description

Base object class to handle a list of raster functions.

Definition at line 32 of file mlRasterFunctionList.h.


Constructor & Destructor Documentation

ml::RasterFunctionList::RasterFunctionList ( ) [inline]

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

Definition at line 36 of file mlRasterFunctionList.h.

virtual ml::RasterFunctionList::~RasterFunctionList ( ) [inline, virtual]

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

Definition at line 39 of file mlRasterFunctionList.h.


Member Function Documentation

virtual void ml::RasterFunctionList::appendToList ( const RasterFunction elem) [inline, virtual]

Permits access to the list of raster functions.

Definition at line 53 of file mlRasterFunctionList.h.

void ml::RasterFunctionList::clear ( )

Clears the inner list.

virtual void ml::RasterFunctionList::clearPersistentState ( char *  ) const [inline, virtual]

Persistence support. Still unimplemented, only for later usage.

Reimplemented from ml::Base.

Definition at line 67 of file mlRasterFunctionList.h.

virtual const RasterFunction& ml::RasterFunctionList::getListElement ( size_t  idx) [inline, virtual]

Permits access to the list of raster functions.

Definition at line 57 of file mlRasterFunctionList.h.

virtual size_t ml::RasterFunctionList::getListSize ( ) [inline, virtual]

Permits access to the list of raster functions.

Definition at line 45 of file mlRasterFunctionList.h.

virtual char* ml::RasterFunctionList::getPersistentState ( ) const [inline, virtual]

Persistence support. Still unimplemented, only for later usage.

Reimplemented from ml::Base.

Definition at line 61 of file mlRasterFunctionList.h.

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.

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

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

virtual void ml::RasterFunctionList::setListElement ( size_t  idx,
const RasterFunction elem 
) [inline, virtual]

Permits access to the list of raster functions.

Definition at line 49 of file mlRasterFunctionList.h.

virtual void ml::RasterFunctionList::setPersistentState ( const char *  ) [inline, virtual]

Persistence support. Still unimplemented, only for later usage.

Reimplemented from ml::Base.

Definition at line 64 of file mlRasterFunctionList.h.

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: