MeVisLabToolboxReference
ml::SphereList Class Reference

Base object managing a list of Sphere objects. More...

#include <mlSphereList.h>

Inheritance diagram for ml::SphereList:
ml::Base

List of all members.

Public Member Functions

 SphereList ()
virtual ~SphereList ()
MLssize_t getNum () const
 returns the number of contained Spheres
void getValue (MLssize_t index, Sphere &obj) const
 get Sphere at given index
Sphere getValue (MLssize_t index) const
 get Sphere at given index
SpheregetPtr (MLssize_t index=-1)
 get Pointer to Sphere at given index, if index is -1, last element is given
void addValue (const Sphere &obj)
 add Sphere at end of list
void setValue (MLssize_t index, const Sphere &obj)
 set value at index
void removeValue (MLssize_t index=-1)
 remove Sphere 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 managing a list of Sphere objects.

Definition at line 28 of file mlSphereList.h.


Constructor & Destructor Documentation

ml::SphereList::SphereList ( ) [inline]

Definition at line 31 of file mlSphereList.h.

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

Definition at line 32 of file mlSphereList.h.


Member Function Documentation

void ml::SphereList::addValue ( const Sphere obj)

add Sphere at end of list

void ml::SphereList::clear ( )

clear all entries

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

Disposes a string previously allocated by getPersistentState().

Reimplemented from ml::Base.

MLssize_t ml::SphereList::getNum ( ) const

returns the number of contained Spheres

virtual char* ml::SphereList::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.

Sphere* ml::SphereList::getPtr ( MLssize_t  index = -1)

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

void ml::SphereList::getValue ( MLssize_t  index,
Sphere obj 
) const

get Sphere at given index

Sphere ml::SphereList::getValue ( MLssize_t  index) const

get Sphere at given index

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

debug print

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

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

virtual void ml::SphereList::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::SphereList::setValue ( MLssize_t  index,
const Sphere obj 
)

set value at index


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