Inheritance diagram for CChemEqElement:

Public Member Functions
	CChemEqElement (const std::string &name="Chem Eq Element", const CCopasiContainer *pParent=NULL)
	CChemEqElement (const CChemEqElement &src, const CCopasiContainer *pParent=NULL)
	~CChemEqElement ()
void	cleanup ()
void	setMultiplicity (const C_FLOAT64 multiplicity)
void	addToMultiplicity (const C_FLOAT64 multiplicity=1.0)
C_FLOAT64	getMultiplicity () const
void	setMetabolite (const std::string &key)
const CMetab *	getMetabolite () const
const std::string &	getMetaboliteKey () const
Friends
std::ostream &	operator<< (std::ostream &os, const CChemEqElement &d)

Constructor & Destructor Documentation

CChemEqElement::CChemEqElement	(	const std::string &	name = `"Chem Eq Element"`,
		const CCopasiContainer *	pParent = `NULL`
	)

Default constructor

Parameters:

const	std::string & name (default: "NoName")
const	CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CChemEqElement::~CChemEqElement ( )

Destructor

Member Function Documentation

void CChemEqElement::addToMultiplicity ( const C_FLOAT64 multiplicity = 1.0 )

Add to the multiplicity of the element.

Parameters:

const C_FLOAT64 multiplicity (default = 1.0)

void CChemEqElement::cleanup ( )

cleanup

const CMetab * CChemEqElement::getMetabolite ( ) const

Retrieves the metabolite of the element.

const std::string & CChemEqElement::getMetaboliteKey ( ) const

Retrieve the key of the species

C_FLOAT64 CChemEqElement::getMultiplicity ( ) const

Retrieves the multiplicity of the element.

void CChemEqElement::setMetabolite ( const std::string & key )

Set the metabolite of the element.

Parameters:

CMetab * metabolite

void CChemEqElement::setMultiplicity ( const C_FLOAT64 multiplicity )

Set the multiplicity of the element.

Parameters:

const C_FLOAT64 multiplicity

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