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

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

#include <mlSphereList.h>

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

Public Member Functions

 SphereList ()
 
 ~SphereList () override
 
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
 
Sphere * getPtr (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
 
- 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 std::string persistentState () const
 Returns a string describing the object's internal state.
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState().
 
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 managing a list of Sphere objects.

Definition at line 29 of file mlSphereList.h.

Constructor & Destructor Documentation

◆ SphereList()

ml::SphereList::SphereList ( )
inline

Definition at line 32 of file mlSphereList.h.

◆ ~SphereList()

ml::SphereList::~SphereList ( )
inlineoverride

Definition at line 33 of file mlSphereList.h.

Member Function Documentation

◆ addValue()

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

add Sphere at end of list

◆ clear()

void ml::SphereList::clear ( )

clear all entries

◆ getNum()

MLssize_t ml::SphereList::getNum ( ) const

returns the number of contained Spheres

◆ getPtr()

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

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

◆ getValue() [1/2]

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

get Sphere at given index

◆ getValue() [2/2]

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

get Sphere at given index

◆ print()

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

debug print

◆ removeValue()

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

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

◆ setValue()

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: