MeVisLabToolboxReference
ml::CurveList Class Reference

Base object class CurveList with a list of CurveData object pointers. More...

#include <mlCurveList.h>

Inheritance diagram for ml::CurveList:
ml::Base

List of all members.

Public Member Functions

virtual CurveListdeepCopy () const
 Creates a deep copy of the given object.
Initialization, destructor
 CurveList ()
 Default constructor.
 CurveList (const CurveList &curveList, bool deepCopyArg=false)
 Copy constructor. The curve objects are only copied if deepCopy is set to true.
virtual ~CurveList ()
 Destructor, referenced curve objects are not deleted.
virtual CurveListoperator= (const CurveList &srcCurveList)
 Assignment operator, copying the pointers to the curve objects, not the objects themselves.
virtual void clear ()
 Initialize data (referenced curve objects are not deleted)
Curve data access
virtual std::vector< CurveData * > & getCurveList ()
 Get vector of CurveData object pointers.
virtual CurveDatagetCurveData (MLssize_t iCurve)
 Get pointer to iCurve-th CurveData object.
Get curve list properties
virtual MLssize_t getNumCurves ()
 Get number of curve objects.
virtual double getXMin ()
 Get overall minimum X data value.
virtual double getXMax ()
 Get overall maximum X data value.
virtual double getYMin ()
 Get overall minimum Y data value.
virtual double getYMax ()
 Get overall maximum Y data value.
virtual void getXYRange (double *xMin, double *xMax, double *yMin, double *yMax)
 Get overall X and Y value ranges (NULL pointers are allowed)
virtual void addStateToTree (TreeNode *parent) const
 Implement export functionality (as used by the SaveBase module):
 ML_SET_ADDSTATE_VERSION (1)
virtual void readStateFromTree (TreeNode *parent)
 Implement import functionality (as used by the LoadBase module):
Deprecated methods.
void getXYRange (float *xMin, float *xMax, float *yMin, float *yMax)

Protected Attributes

std::vector< CurveData * > _curveList
 List of curve object pointers.

Detailed Description

Base object class CurveList with a list of CurveData object pointers.

The CurveData objects referenced by this list are not owned by the list, i.e. the creator of the objects is responsible for deleting them.

Definition at line 41 of file mlCurveList.h.


Constructor & Destructor Documentation

ml::CurveList::CurveList ( )

Default constructor.

ml::CurveList::CurveList ( const CurveList curveList,
bool  deepCopyArg = false 
)

Copy constructor. The curve objects are only copied if deepCopy is set to true.

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

Destructor, referenced curve objects are not deleted.

Definition at line 56 of file mlCurveList.h.


Member Function Documentation

virtual void ml::CurveList::addStateToTree ( TreeNode parent) const [virtual]

Implement export functionality (as used by the SaveBase module):

Reimplemented from ml::Base.

virtual void ml::CurveList::clear ( ) [virtual]

Initialize data (referenced curve objects are not deleted)

virtual CurveList* ml::CurveList::deepCopy ( ) const [inline, virtual]

Creates a deep copy of the given object.

The default implementation returns a NULL pointer and has to be overloaded by derived classes. It can be used to clone Base objects without knowledge of the exact type of object.

Reimplemented from ml::Base.

Definition at line 110 of file mlCurveList.h.

virtual CurveData* ml::CurveList::getCurveData ( MLssize_t  iCurve) [virtual]

Get pointer to iCurve-th CurveData object.

virtual std::vector<CurveData*>& ml::CurveList::getCurveList ( ) [virtual]

Get vector of CurveData object pointers.

virtual MLssize_t ml::CurveList::getNumCurves ( ) [virtual]

Get number of curve objects.

virtual double ml::CurveList::getXMax ( ) [virtual]

Get overall maximum X data value.

virtual double ml::CurveList::getXMin ( ) [virtual]

Get overall minimum X data value.

void ml::CurveList::getXYRange ( float *  xMin,
float *  xMax,
float *  yMin,
float *  yMax 
)
Deprecated:
Get overall X and Y value ranges as floats (NULL pointers are allowed)
virtual void ml::CurveList::getXYRange ( double *  xMin,
double *  xMax,
double *  yMin,
double *  yMax 
) [virtual]

Get overall X and Y value ranges (NULL pointers are allowed)

virtual double ml::CurveList::getYMax ( ) [virtual]

Get overall maximum Y data value.

virtual double ml::CurveList::getYMin ( ) [virtual]

Get overall minimum Y data value.

ml::CurveList::ML_SET_ADDSTATE_VERSION ( )
virtual CurveList& ml::CurveList::operator= ( const CurveList srcCurveList) [virtual]

Assignment operator, copying the pointers to the curve objects, not the objects themselves.

virtual void ml::CurveList::readStateFromTree ( TreeNode parent) [virtual]

Implement import functionality (as used by the LoadBase module):

Reimplemented from ml::Base.


Member Data Documentation

std::vector<CurveData*> ml::CurveList::_curveList [protected]

List of curve object pointers.

Definition at line 126 of file mlCurveList.h.


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