#include <CODEExporterXPPAUT.h>

Inheritance diagram for CODEExporterXPPAUT:

Public Member Functions
	CODEExporterXPPAUT ()

bool	exportClosingData (const CModel *copasiModel, std::ostream &os)

virtual bool	exportSingleCompartment (const CCompartment *comp, std::string &expression, std::string &comments)

void	exportSingleLine (const std::string &line, std::ostringstream &which)

virtual bool	exportSingleMetabolite (const CMetab *metab, std::string &expression, std::string &comments)

virtual bool	exportSingleModelEntity (const CModelEntity *tmp, std::string &expression, std::string &comments)

virtual bool	exportSingleModVal (const CModelValue *modval, std::string &expression, std::string &comments)

virtual bool	exportSingleObject (std::ostringstream &which, const std::string &name, const std::string &expression, const std::string &comments)

virtual bool	exportSingleODE (const CModelEntity *mentity, std::string &equation, std::string &comments)

virtual bool	exportSingleParameter (const CCopasiParameter *param, std::string &expression, std::string &comments)

virtual bool	exportTitleData (const CDataModel *pDataModel, std::ostream &os)

virtual std::string	exportTitleString (const size_t tmp)

virtual std::string	getDisplayExpressionString (CExpression *tmp)

virtual std::string	getDisplayFunctionString (CFunction *func)

virtual std::string	KineticFunction2ODEmember (const CReaction *reac)

std::string	setConcentrationName (const std::string &objName)

std::string	setODEName (const std::string &objName)

virtual void	setReservedNames ()

std::string	testName (const std::string &name)

virtual std::string	translateObjectName (const std::string &realName)

virtual std::string	translateTimeVariableName ()

Public Member Functions inherited from CODEExporter
void	assembleSubTreeForMassAction (CEvaluationNode newNode, CEvaluationNode child1, CEvaluationNode *child2)

	CODEExporter ()

virtual std::string	exportClosingString (const size_t tmp)

bool	exportCompartments (const CModel *copasiModel)

std::string	exportExpression (const CExpression pExpression, const CDataModel pDataModel)

virtual bool	exportKineticFunction (const CReaction *reac)

virtual bool	exportKineticFunctionGroup (const CModel *copasiModel)

virtual bool	exportMetabolites (const CModel *copasiModel)

virtual bool	exportMetabolitesConcentrations (const CModel *copasiModel)

bool	exportModelEntityExpression (const CDataObject obj, const CDataModel pDataModel)

bool	exportModelValues (const CModel *copasiModel)

bool	exportModelValuesExpressions (const CModel *copasiModel)

virtual std::string	exportNumber (double number)

void	exportObjectNodesFromModel (const CDataModel *pDataModel)

bool	exportODEs (const CModel *copasiModel)

bool	exportReacParamsAndFuncs (const CModel *copasiModel)

void	exportSimulatedObject (const CDataObject obj, const CDataModel pDataModel)

bool	exportSingleFunction (CEvaluationNode pNode, const CReaction reac, size_t &index)

bool	exportSingleFunction (CEvaluationNode *pNode, const std::string &key, size_t &index)

bool	exportSingleFunction (const CFunction *func)

virtual bool	exportSingleFunction (const CFunction *func, std::set< std::string > &isExported)

virtual bool	exportTitleData (const CModel *copasiModel, std::ostream &os)

bool	exportToStream (const CDataModel *pDataModel, std::ostream &os)

void	findFunctionsCalls (const CEvaluationNode *pNode)

virtual std::string	getSingleLineComment ()

virtual bool	isEmptyString (std::string &str)

std::string	isModelEntityExpressionODEExporterCompatible (const CModelEntity tmp, const CExpression pExpression, const CDataModel *pDataModel)

void	modifyTreeForMassAction (CFunction *tmpfunc)

virtual bool	preprocess (const CModel *copasiModel)

virtual	~CODEExporter ()

Public Attributes
std::map< std::string, unsigned C_INT32 >	Frequancy

std::set< std::string >	NameSet

Public Attributes inherited from CODEExporter
std::ostringstream	assignment

std::map< std::string, std::string >	equations

std::ostringstream	fixed

std::ostringstream	functions

std::ostringstream	headers

std::ostringstream	initial

std::map< std::string, std::string >	NameMap

std::ostringstream	ode

std::string	timeKey

Additional Inherited Members
Public Types inherited from CODEExporter
enum	Object { INITIAL = 0 , FIXED , ASSIGNMENT , HEADERS , FUNCTIONS , ODEs }

Protected Attributes inherited from CODEExporter
std::set< std::string >	mExportedFunctions

Constructor & Destructor Documentation

◆ CODEExporterXPPAUT()

CODEExporterXPPAUT::CODEExporterXPPAUT ( )

Constructor for the exporter.

Member Function Documentation

◆ exportClosingData()

bool CODEExporterXPPAUT::exportClosingData	(	const CModel *	copasiModel,
		std::ostream &	os
	)

virtual

Reimplemented from CODEExporter.

◆ exportSingleCompartment()

bool CODEExporterXPPAUT::exportSingleCompartment	(	const CCompartment *	comp,
		std::string &	expression,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References CModelEntity::ASSIGNMENT, CODEExporter::assignment, exportSingleObject(), CModelEntity::FIXED, CODEExporter::fixed, CModelEntity::getKey(), CModelEntity::getStatus(), CODEExporter::initial, CODEExporter::NameMap, and CModelEntity::ODE.

◆ exportSingleLine()

void CODEExporterXPPAUT::exportSingleLine	(	const std::string &	line,
		std::ostringstream &	which
	)

References MCODEExporter, and CCopasiMessage::WARNING.

Referenced by exportSingleObject().

◆ exportSingleMetabolite()

bool CODEExporterXPPAUT::exportSingleMetabolite	(	const CMetab *	metab,
		std::string &	expression,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References CModelEntity::ASSIGNMENT, CODEExporter::assignment, exportSingleObject(), CModelEntity::FIXED, CODEExporter::fixed, CModelEntity::getKey(), CModelEntity::getStatus(), CODEExporter::initial, CMetab::isDependent(), CODEExporter::NameMap, CModelEntity::ODE, and CModelEntity::REACTIONS.

◆ exportSingleModelEntity()

bool CODEExporterXPPAUT::exportSingleModelEntity	(	const CModelEntity *	tmp,
		std::string &	expression,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References CModelEntity::ASSIGNMENT, CODEExporter::assignment, exportSingleObject(), CModelEntity::FIXED, CODEExporter::fixed, CModelEntity::getKey(), CModelEntity::getStatus(), CODEExporter::initial, CODEExporter::NameMap, and CModelEntity::ODE.

◆ exportSingleModVal()

bool CODEExporterXPPAUT::exportSingleModVal	(	const CModelValue *	modval,
		std::string &	expression,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References CModelEntity::ASSIGNMENT, CODEExporter::assignment, exportSingleObject(), CModelEntity::FIXED, CODEExporter::fixed, CModelEntity::getKey(), CModelEntity::getStatus(), CODEExporter::initial, CODEExporter::NameMap, and CModelEntity::ODE.

◆ exportSingleObject()

bool CODEExporterXPPAUT::exportSingleObject	(	std::ostringstream &	which,
		const std::string &	name,
		const std::string &	expression,
		const std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References exportSingleLine().

Referenced by exportSingleCompartment(), exportSingleMetabolite(), exportSingleModelEntity(), exportSingleModVal(), exportSingleODE(), and exportSingleParameter().

◆ exportSingleODE()

bool CODEExporterXPPAUT::exportSingleODE	(	const CModelEntity *	mentity,
		std::string &	equation,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References exportSingleObject(), CModelEntity::getKey(), CODEExporter::isEmptyString(), CODEExporter::NameMap, and CODEExporter::ode.

◆ exportSingleParameter()

bool CODEExporterXPPAUT::exportSingleParameter	(	const CCopasiParameter *	param,
		std::string &	expression,
		std::string &	comments
	)

virtual

Reimplemented from CODEExporter.

References exportSingleObject(), CODEExporter::fixed, CCopasiParameter::getKey(), and CODEExporter::NameMap.

◆ exportTitleData()

bool CODEExporterXPPAUT::exportTitleData	(	const CDataModel *	pDataModel,
		std::ostream &	os
	)

virtual

References CTrajectoryProblem::getDuration(), CCopasiTask::getProblem(), and CTrajectoryProblem::getStepSize().

◆ exportTitleString()

std::string CODEExporterXPPAUT::exportTitleString ( const size_t tmp )

virtual

Reimplemented from CODEExporter.

References CODEExporter::ASSIGNMENT, CODEExporter::FIXED, CODEExporter::FUNCTIONS, CODEExporter::HEADERS, CODEExporter::INITIAL, and CODEExporter::ODEs.

◆ getDisplayExpressionString()

std::string CODEExporterXPPAUT::getDisplayExpressionString ( CExpression * tmp )

virtual

Reimplemented from CODEExporter.

References CEvaluationNode::buildXPPString(), and CEvaluationTree::getRoot().

◆ getDisplayFunctionString()

std::string CODEExporterXPPAUT::getDisplayFunctionString ( CFunction * func )

virtual

Reimplemented from CODEExporter.

References CEvaluationNode::buildXPPString(), and CEvaluationTree::getRoot().

◆ KineticFunction2ODEmember()

std::string CODEExporterXPPAUT::KineticFunction2ODEmember ( const CReaction * reac )

virtual

Reimplemented from CODEExporter.

References CReaction::getKey(), and CODEExporter::NameMap.

◆ setConcentrationName()

std::string CODEExporterXPPAUT::setConcentrationName ( const std::string & objName )

virtual

Reimplemented from CODEExporter.

◆ setODEName()

std::string CODEExporterXPPAUT::setODEName ( const std::string & objName )

virtual

Reimplemented from CODEExporter.

◆ setReservedNames()

void CODEExporterXPPAUT::setReservedNames ( )

virtual

Reimplemented from CODEExporter.

References Frequancy, and NameSet.

◆ testName()

std::string CODEExporterXPPAUT::testName ( const std::string & name )

This method tests whether the given XPPAUT name already assigned, put the new name (in cappital letters: all names can be upper or lower case) in the set of assigned names or modify the name

References CCopasiMessage::ERROR, fatalError, Frequancy, and NameSet.

Referenced by translateObjectName().

◆ translateObjectName()

std::string CODEExporterXPPAUT::translateObjectName ( const std::string & realName )

virtual

This method adapt a Copasi name for XPPAUT syntax: all XPPAUT names can have up to 9 letters each. Names can not start with a number. Any other combination of letters and numbers is valid as is the underscore.

Reimplemented from CODEExporter.

References testName().

◆ translateTimeVariableName()

std::string CODEExporterXPPAUT::translateTimeVariableName ( )

virtual

Reimplemented from CODEExporter.

Member Data Documentation

◆ Frequancy

std::map< std::string, unsigned C_INT32 > CODEExporterXPPAUT::Frequancy

Referenced by setReservedNames(), and testName().

◆ NameSet

std::set<std::string> CODEExporterXPPAUT::NameSet

Referenced by setReservedNames(), and testName().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CODEExporterXPPAUT()

Member Function Documentation

◆ exportClosingData()

◆ exportSingleCompartment()

◆ exportSingleLine()

◆ exportSingleMetabolite()

◆ exportSingleModelEntity()

◆ exportSingleModVal()

◆ exportSingleObject()

◆ exportSingleODE()

◆ exportSingleParameter()

◆ exportTitleData()

◆ exportTitleString()

◆ getDisplayExpressionString()

◆ getDisplayFunctionString()

◆ KineticFunction2ODEmember()

◆ setConcentrationName()

◆ setODEName()

◆ setReservedNames()

◆ testName()

◆ translateObjectName()

◆ translateTimeVariableName()

Member Data Documentation

◆ Frequancy

◆ NameSet