CExperimentObjectMap::CDataColumn Class Reference

#include <CExperimentObjectMap.h>

Inheritance diagram for CExperimentObjectMap::CDataColumn:

List of all members.

Public Member Functions
	CDataColumn (const std::string &name="Object Map", const CCopasiContainer *pParent=NULL)
	CDataColumn (const CDataColumn &src, const CCopasiContainer *pParent=NULL)
	CDataColumn (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
virtual	~CDataColumn ()
CDataColumn &	operator= (const CDataColumn &rhs)
virtual bool	elevateChildren ()
bool	setRole (const CExperiment::Type &role)
const CExperiment::Type &	getRole () const
bool	setObjectCN (const std::string &objectCN)
std::string	getObjectCN () const
bool	setWeight (const C_FLOAT64 &weight)
C_FLOAT64	getWeight () const
C_FLOAT64	getDefaultWeight () const

---

Constructor & Destructor Documentation

CExperimentObjectMap::CDataColumn::CDataColumn	(	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::CDataColumn::CDataColumn	(	const CDataColumn &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

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

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

Specific constructor used for reading COPASI files

Parameters:

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

CExperimentObjectMap::CDataColumn::~CDataColumn

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CExperimentObjectMap::CDataColumn::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::CDataColumn::getDefaultWeight

(

)

const

Retrieve the default weight of the column

Returns:

C_FLOAT64 weight

std::string CExperimentObjectMap::CDataColumn::getObjectCN

(

)

const

Retrieve the object CN of the object mapped to the column

Returns:

std::string objctCN

const CExperiment::Type & CExperimentObjectMap::CDataColumn::getRole

(

)

const

Retrieve the role of the column

Returns:

const CExperiment::Type & role

C_FLOAT64 CExperimentObjectMap::CDataColumn::getWeight

(

)

const

Retrieve the weight of the column

Returns:

C_FLOAT64 weight

CExperimentObjectMap::CDataColumn & CExperimentObjectMap::CDataColumn::operator=

(

const CDataColumn &

rhs

)

Assignment operator

Parameters:

const

CDataColumn & rhs

Returns:

CDataColumn & lhs

bool CExperimentObjectMap::CDataColumn::setObjectCN

(

const std::string &

objectCN

)

Set the object CN of the object mapped to the column

Parameters:

const

std::string & objectCN

Returns:

bool success

bool CExperimentObjectMap::CDataColumn::setRole

(

const CExperiment::Type &

role

)

Set the role of the column

Parameters:

const

CExperiment::Type & role

Returns:

bool success

bool CExperimentObjectMap::CDataColumn::setWeight

(

const C_FLOAT64 &

weight

)

Set the weight for the column

Parameters:

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