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

#include <mlCurveList.h>

Inheritance diagram for ml::CurveList:

Public Member Functions
CurveList *	deepCopy () const override
	Set addStateToTree version number that can be accessed via getAddStateVersion() More...

Curve data access
virtual std::vector< CurveData * > &	getCurveList ()
	Get vector of CurveData object pointers. More...

virtual CurveData *	getCurveData (MLssize_t iCurve)
	Get pointer to iCurve-th CurveData object. More...

Get curve list properties
virtual MLssize_t	getNumCurves ()
	Get number of curve objects. More...

virtual double	getXMin ()
	Get overall minimum X data value. More...

virtual double	getXMax ()
	Get overall maximum X data value. More...

virtual double	getYMin ()
	Get overall minimum Y data value. More...

virtual double	getYMax ()
	Get overall maximum Y data value. More...

virtual void	getXYRange (double xMin, double xMax, double yMin, double yMax)
	Get overall X and Y value ranges (NULL pointers are allowed) More...


void	addStateToTree (TreeNode *parent) const override

	ML_SET_ADDSTATE_VERSION (1)

void	readStateFromTree (TreeNode *parent) override
	Implement import functionality (as used by the LoadBase module): More...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

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. More...

virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase. More...

virtual std::string	detailString () const
	Return a string describing this object. More...

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class. More...

virtual std::string	persistentState () const
	Returns a string describing the object's internal state. More...

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`. More...

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object. More...

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object. More...

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

Initialization, destructor
	CurveList ()
	Default constructor. More...

	CurveList (const CurveList &curveList, bool deepCopyArg=false)
	Copy constructor. The curve objects are only copied if deepCopy is set to true. More...

	~CurveList () override
	Destructor, referenced curve objects are not deleted. More...

virtual CurveList &	operator= (const CurveList &srcCurveList)
	Assignment operator, copying the pointers to the curve objects, not the objects themselves. More...

virtual void	clear ()
	Initialize data (referenced curve objects are not deleted) More...

MLBASEEXPORT friend bool	operator== (const CurveList &x, const CurveList &y)

MLBASEEXPORT friend bool	operator!= (const CurveList &x, const CurveList &y)

Additional Inherited Members
Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Protected Member Functions inherited from ml::Base
virtual char *	getPersistentState () const
	Returns a C string describing the object's internal state. More...

virtual void	setPersistentState (const char *)
	Restores the object's internal state from a string that had been previously generated using `getPersistentState()`. More...

virtual void	clearPersistentState (char *) const
	Disposes a string previously allocated by `getPersistentState()`. More...

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 45 of file mlCurveList.h.

Constructor & Destructor Documentation

◆ CurveList() [1/2]

ml::CurveList::CurveList ( )

Default constructor.

◆ CurveList() [2/2]

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

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

◆ ~CurveList()

ml::CurveList::~CurveList ( )

inlineoverride

Destructor, referenced curve objects are not deleted.

Definition at line 60 of file mlCurveList.h.

Member Function Documentation

◆ addStateToTree()

void ml::CurveList::addStateToTree ( TreeNode * parent ) const

overridevirtual

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

Reimplemented from ml::Base.

◆ clear()

virtual void ml::CurveList::clear ( )

virtual

Initialize data (referenced curve objects are not deleted)

◆ deepCopy()

CurveList* ml::CurveList::deepCopy ( ) const

inlineoverridevirtual

Set addStateToTree version number that can be accessed via getAddStateVersion()

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 117 of file mlCurveList.h.

◆ getCurveData()

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

virtual

Get pointer to iCurve-th CurveData object.

◆ getCurveList()

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

virtual

Get vector of CurveData object pointers.

◆ getNumCurves()

virtual MLssize_t ml::CurveList::getNumCurves ( )

virtual

Get number of curve objects.

◆ getXMax()

virtual double ml::CurveList::getXMax ( )

virtual

Get overall maximum X data value.

◆ getXMin()

virtual double ml::CurveList::getXMin ( )

virtual

Get overall minimum X data value.

◆ getXYRange()

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)

◆ getYMax()

virtual double ml::CurveList::getYMax ( )

virtual

Get overall maximum Y data value.

◆ getYMin()

virtual double ml::CurveList::getYMin ( )

virtual

Get overall minimum Y data value.

◆ ML_SET_ADDSTATE_VERSION()

ml::CurveList::ML_SET_ADDSTATE_VERSION ( 1 )

◆ operator=()

virtual CurveList& ml::CurveList::operator= ( const CurveList & srcCurveList )

virtual

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

◆ readStateFromTree()

void ml::CurveList::readStateFromTree ( TreeNode * parent )

overridevirtual

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

Reimplemented from ml::Base.

Friends And Related Function Documentation

◆ operator!=

MLBASEEXPORT friend bool operator!=	(	const CurveList &	x,
		const CurveList &	y
	)

friend

◆ operator==

MLBASEEXPORT friend bool operator==	(	const CurveList &	x,
		const CurveList &	y
	)

friend

Member Data Documentation

◆ _curveList

std::vector<CurveData*> ml::CurveList::_curveList

protected

List of curve object pointers.

Definition at line 133 of file mlCurveList.h.

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

MeVisLab/Standard/Sources/ML/MLBase/mlCurveList.h

Public Member Functions

Protected Attributes

Initialization, destructor

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CurveList() [1/2]

◆ CurveList() [2/2]

◆ ~CurveList()

Member Function Documentation

◆ addStateToTree()

◆ clear()

◆ deepCopy()

◆ getCurveData()

◆ getCurveList()

◆ getNumCurves()

◆ getXMax()

◆ getXMin()

◆ getXYRange()

◆ getYMax()

◆ getYMin()

◆ ML_SET_ADDSTATE_VERSION()

◆ operator=()

◆ readStateFromTree()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ _curveList