CChemEqInterface Class Reference

#include <CChemEqInterface.h>

List of all members.

Public Member Functions
	CChemEqInterface (CModel *pModel)
	~CChemEqInterface ()
std::string	getChemEqString (bool expanded) const
bool	setChemEqString (const std::string &ces)
bool	loadFromChemEq (const CChemEq &ce)
bool	writeToChemEq (CChemEq &ce) const
const std::vector< C_FLOAT64 > &	getListOfMultiplicities (CFunctionParameter::Role role) const
const std::vector< std::string > &	getListOfDisplayNames (CFunctionParameter::Role role) const
void	addModifier (const std::string &name)
void	clearModifiers ()
bool	getReversibility () const
void	setReversibility (bool rev)
bool	isMulticompartment () const
const CCompartment *	getCompartment () const
void	reverse ()
unsigned C_INT32	getMolecularity (CFunctionParameter::Role role) const
std::set< std::string >	listOfNonUniqueMetabNames () const
std::set< std::pair < std::string, std::string > >	listOfNonExistingMetabNames () const
bool	createNonExistingMetabs ()
Static Public Member Functions
static std::string	getChemEqString (CModel *model, const CReaction &rea, bool expanded)
static void	setChemEqFromString (CModel *model, CReaction &rea, const std::string &ces)
static bool	isValidEq (const std::string &eq)

---

Detailed Description

This class describes a chemical equation based on metabolite names It supports parsing and generating string representations. Note that this class handles only metab names without caring about whether these metabs exist in the model. There is however a method to create the missing metabs.

---

Constructor & Destructor Documentation

CChemEqInterface::CChemEqInterface

(

CModel *

pModel

)

CChemEqInterface::~CChemEqInterface

(

)

---

Member Function Documentation

void CChemEqInterface::addModifier

(

const std::string &

name

)

add a modifier to the chemical equation. It is only added if it is not alreay in there.

void CChemEqInterface::clearModifiers

(

)

bool CChemEqInterface::createNonExistingMetabs

(

)

std::string CChemEqInterface::getChemEqString

(

bool

expanded

)

const

std::string CChemEqInterface::getChemEqString	(	CModel *	model,
		const CReaction &	rea,
		bool	expanded
	)		[static]

const CCompartment * CChemEqInterface::getCompartment

(

)

const

convenience method. If the reaction is single compartment the compartment is returned, else NULL.

const std::vector< std::string > & CChemEqInterface::getListOfDisplayNames

(

CFunctionParameter::Role

role

)

const

const std::vector< C_FLOAT64 > & CChemEqInterface::getListOfMultiplicities

(

CFunctionParameter::Role

role

)

const

unsigned C_INT32 CChemEqInterface::getMolecularity

(

CFunctionParameter::Role

role

)

const

bool CChemEqInterface::getReversibility

(

)

const [inline]

bool CChemEqInterface::isMulticompartment

(

)

const

this method tries to find out if the chemical equation involves several compartments in a given model. It only takes into account the metabs that actually exist in the model. A non existing metabolite is assumed not to be in a different compartment

bool CChemEqInterface::isValidEq

(

const std::string &

eq

)

[static]

std::set< std::pair< std::string, std::string > > CChemEqInterface::listOfNonExistingMetabNames

(

)

const

std::set< std::string > CChemEqInterface::listOfNonUniqueMetabNames

(

)

const

bool CChemEqInterface::loadFromChemEq

(

const CChemEq &

ce

)

void CChemEqInterface::reverse

(

)

void CChemEqInterface::setChemEqFromString	(	CModel *	model,
		CReaction &	rea,
		const std::string &	ces
	)		[static]

bool CChemEqInterface::setChemEqString

(

const std::string &

ces

)

void CChemEqInterface::setReversibility

(

bool

rev

)

[inline]

bool CChemEqInterface::writeToChemEq

(

CChemEq &

ce

)

const

---

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

• copasi/model/CChemEqInterface.h
• copasi/model/CChemEqInterface.cpp