MeVisLabToolboxReference
ml::DiscList Class Reference

Base object class DiscList. More...

#include <mlDiscList.h>

Inheritance diagram for ml::DiscList:
ml::Base

List of all members.

Public Member Functions

 DiscList ()
virtual ~DiscList ()
MLssize_t getNum () const
 returns the number of contained Discs
void getValue (MLssize_t index, Disc &obj) const
 get Disc at given index
Disc getValue (MLssize_t index) const
 get Disc at given index
DiscgetPtr (MLssize_t index=-1)
 get Pointer to Disc at given index, if index is -1, last element is given
void addValue (const Disc &obj)
 add Disc at end of list
void setValue (MLssize_t index, const Disc &obj)
 set value at index
void removeValue (MLssize_t index=-1)
 remove Disc from list, if index is -1, last element is removed
void clear ()
 clear all entries
void print (const char *txt)
 debug print
Implementation of the virtual Base class functions for persistence; see class Base for details.
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state.
virtual void setPersistentState (const char *state)
 Restores the object's internal state from a string that had been previously generated using getPersistentState().
virtual void clearPersistentState (char *state) const
 Disposes a string previously allocated by getPersistentState().

Detailed Description

Base object class DiscList.

Definition at line 35 of file mlDiscList.h.


Constructor & Destructor Documentation

ml::DiscList::DiscList ( ) [inline]

Definition at line 38 of file mlDiscList.h.

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

Definition at line 39 of file mlDiscList.h.


Member Function Documentation

void ml::DiscList::addValue ( const Disc obj)

add Disc at end of list

void ml::DiscList::clear ( )

clear all entries

virtual void ml::DiscList::clearPersistentState ( char *  ) const [virtual]

Disposes a string previously allocated by getPersistentState().

Reimplemented from ml::Base.

MLssize_t ml::DiscList::getNum ( ) const

returns the number of contained Discs

virtual char* ml::DiscList::getPersistentState ( ) const [virtual]

Returns a C string describing the object's internal state.

The memory for the string will be allocated here and has to be deallocated using clearPersistentState().

Reimplemented from ml::Base.

Disc* ml::DiscList::getPtr ( MLssize_t  index = -1)

get Pointer to Disc at given index, if index is -1, last element is given

void ml::DiscList::getValue ( MLssize_t  index,
Disc obj 
) const

get Disc at given index

Disc ml::DiscList::getValue ( MLssize_t  index) const

get Disc at given index

void ml::DiscList::print ( const char *  txt)

debug print

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

remove Disc from list, if index is -1, last element is removed

virtual void ml::DiscList::setPersistentState ( const char *  ) [virtual]

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

Reimplemented from ml::Base.

void ml::DiscList::setValue ( MLssize_t  index,
const Disc obj 
)

set value at index


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