CMoiety Class Reference

#include <CMoiety.h>

Inheritance diagram for CMoiety:

List of all members.

Public Member Functions
	CMoiety (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CMoiety (const CMoiety &src, const CCopasiContainer *pParent=NULL)
	~CMoiety ()
void	add (C_FLOAT64 value, CMetab *metabolite)
void	cleanup ()
void	refreshInitialValue ()
CCopasiObject *	getInitialValueReference () const
void	refreshValue ()
CCopasiObject *	getValueReference () const
std::string	getDescription (const CModel *model) const
const C_FLOAT64 &	dependentNumber ()
const C_FLOAT64 &	getDependentNumber () const
C_FLOAT64	getNumber () const
virtual const std::string &	getKey () const
void	refreshDependentNumber ()
std::string	getExpression () const

---

Detailed Description

:pos 52.0066,117.162

---

Constructor & Destructor Documentation

CMoiety::CMoiety	(	const std::string &	name = "NoName",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

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

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

Copy constructor

Parameters:

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

CMoiety::~CMoiety

(

)

Destructor

---

Member Function Documentation

void CMoiety::add	(	C_FLOAT64	value,
		CMetab *	metabolite
	)

Saves the contents of the object to a CWriteConfig object. This saves the data in Gepasi 3.21 file format

Parameters:

pconfigbuffer

reference to a CWriteConfig object.

Returns:

Fail Add a metabolite to a moiety

Parameters:

C_FLOAT64	value
CMetab	* metabolite

void CMoiety::cleanup

(

)

const C_FLOAT64 & CMoiety::dependentNumber

(

)

Retrieve and refresh the dependent number;

Returns:

const C_FLOAT64 & dependentNumber

const C_FLOAT64 & CMoiety::getDependentNumber

(

)

const

Retrieve the dependent number;

Returns:

const C_FLOAT64 & dependentNumber

std::string CMoiety::getDescription

(

const CModel *

model

)

const

get the string representation of the moiety using the CMetabNameInterface

std::string CMoiety::getExpression

(

)

const

Retrieve the infix expression, which can be used to calculate the total ammount.

Returns:

std::string expression

CCopasiObject * CMoiety::getInitialValueReference

(

)

const

Retrieve the object for the total particle number

Returns:

CCopasiObject * initialValueReference

const std::string & CMoiety::getKey

(

)

const [virtual]

Returns a string with the name of this compartment.

Returns:

std::string key

Reimplemented from CCopasiObject.

C_FLOAT64 CMoiety::getNumber

(

)

const

CCopasiObject * CMoiety::getValueReference

(

)

const

Retrieve the object for the total particle number

Returns:

CCopasiObject * valueReference

void CMoiety::refreshDependentNumber

(

)

Refreshes the value of the dependent number

void CMoiety::refreshInitialValue

(

)

Refresh the initial total particle number

void CMoiety::refreshValue

(

)

Refresh the total particle number

---

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

• copasi/model/CMoiety.h
• copasi/model/CMoiety.cpp