CExperimentObjectMap Class Reference

#include <CExperimentObjectMap.h>

Inheritance diagram for CExperimentObjectMap:

List of all members.

Classes
class	CDataColumn
Public Member Functions
	CExperimentObjectMap (const std::string &name="Object Map", const CCopasiContainer *pParent=NULL)
	CExperimentObjectMap (const CExperimentObjectMap &src, const CCopasiContainer *pParent=NULL)
	CExperimentObjectMap (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
virtual	~CExperimentObjectMap ()
virtual bool	elevateChildren ()
bool	setNumCols (const unsigned C_INT32 &numCols)
unsigned C_INT32	getLastNotIgnoredColumn () const
virtual const std::string &	getName (const unsigned C_INT32 &index) const
bool	setRole (const unsigned C_INT32 &index, const CExperiment::Type &role)
CExperiment::Type	getRole (const unsigned C_INT32 &index) const
bool	setObjectCN (const unsigned C_INT32 &index, const std::string &objectCN)
std::string	getObjectCN (const unsigned C_INT32 &index) const
bool	setWeight (const unsigned C_INT32 &index, const C_FLOAT64 &weight)
C_FLOAT64	getWeight (const unsigned C_INT32 &index) const
C_FLOAT64	getDefaultWeight (const unsigned C_INT32 &index) const
bool	compile (const std::vector< CCopasiContainer * > listOfContainer=CCopasiContainer::EmptyList)
const CVector< CCopasiObject * > &	getMappedObjects () const
const unsigned C_INT32 &	getLastColumn () const

---

Constructor & Destructor Documentation

CExperimentObjectMap::CExperimentObjectMap	(	const std::string &	name = "Object Map",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	std::string & name (default: Object Map)
const	CCopasiContainer * pParent (default: NULL)

CExperimentObjectMap::CExperimentObjectMap	(	const CExperimentObjectMap &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

const	CExperimentObjectMap & src
const	CCopasiContainer * pParent (default: NULL)

CExperimentObjectMap::CExperimentObjectMap	(	const CCopasiParameterGroup &	group,
		const CCopasiContainer *	pParent = NULL
	)

Specific constructor used for reading copasi files

Parameters:

const	CCopasiParameterGroup & group
const	CCopasiContainer * pParent (default: NULL)

CExperimentObjectMap::~CExperimentObjectMap

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CExperimentObjectMap::compile

(

const std::vector< CCopasiContainer * >

listOfContainer = CCopasiContainer::EmptyList

)

Compile the map. This function must be called before any operations can be performed.

Parameters:

const

std::vector< CCopasiContainer * > listOfContainer

Returns:

bool success

bool CExperimentObjectMap::elevateChildren

(

)

[virtual]

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns:

bool success

Reimplemented from CCopasiParameterGroup.

C_FLOAT64 CExperimentObjectMap::getDefaultWeight

(

const unsigned C_INT32 &

index

)

const

Retrieve the default weight according to the selected weight method of the indexed column

Parameters:

const

unsigned C_INT32 & index

Returns:

C_FLOAT64 weight

const unsigned C_INT32 & CExperimentObjectMap::getLastColumn

(

)

const

Retrieve the last mapped column number

Returns:

const unsigned C_INT32 & lastColumn

unsigned C_INT32 CExperimentObjectMap::getLastNotIgnoredColumn

(

)

const

Retrieve the last non ignored column

Returns:

unsigned C_INT32 lastNotIgnoredColumn

const CVector< CCopasiObject * > & CExperimentObjectMap::getMappedObjects

(

)

const

Retrieve the vector of mapped objects

Returns:

const CVector< CCopasiObject * > & mappedObjects

const std::string & CExperimentObjectMap::getName

(

const unsigned C_INT32 &

index

)

const [virtual]

Retrieve the name of a parameter or subgroup

Parameters:

const

unsigned C_INT32 & index

Returns:

std::string name

Reimplemented from CCopasiParameterGroup.

std::string CExperimentObjectMap::getObjectCN

(

const unsigned C_INT32 &

index

)

const

Retrieve the object CN of the object mapped to the indexed column

Parameters:

const

unsigned C_INT32 & index

Returns:

std::stringobjctCN

CExperiment::Type CExperimentObjectMap::getRole

(

const unsigned C_INT32 &

index

)

const

Retrieve the role of the indexed column

Parameters:

const

unsigned C_INT32 & index

Returns:

CExperiment::Type role

C_FLOAT64 CExperimentObjectMap::getWeight

(

const unsigned C_INT32 &

index

)

const

Retrieve the weight of the indexed column

Parameters:

const

unsigned C_INT32 & index

Returns:

C_FLOAT64 weight

bool CExperimentObjectMap::setNumCols

(

const unsigned C_INT32 &

numCols

)

Set the number of data columns

Parameters:

const

unsigned C_INT32 & numCols

Returns:

bool success

bool CExperimentObjectMap::setObjectCN	(	const unsigned C_INT32 &	index,
		const std::string &	objectCN
	)

Set the object CN of the object mapped to the indexed column

Parameters:

const	unsigned C_INT32 & index
const	std::string & objectCN

Returns:

bool success

bool CExperimentObjectMap::setRole	(	const unsigned C_INT32 &	index,
		const CExperiment::Type &	role
	)

Set the role of the indexed column

Parameters:

const	unsigned C_INT32 & index
const	CExperiment::Type & role

Returns:

bool success

bool CExperimentObjectMap::setWeight	(	const unsigned C_INT32 &	index,
		const C_FLOAT64 &	weight
	)

Set the weight for the indexed column

Parameters:

const	unsigned C_INT32 & index
const	C_FLOAT64 & weight

Returns:

bool success

---

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

• copasi/parameterFitting/CExperimentObjectMap.h
• copasi/parameterFitting/CExperimentObjectMap.cpp