CCopasiXML Class Reference

#include <CCopasiXML.h>

Inheritance diagram for CCopasiXML:

List of all members.

Public Member Functions
	CCopasiXML ()
	~CCopasiXML ()
virtual bool	save (std::ostream &os, const std::string &relativeTo)
virtual bool	load (std::istream &is, const std::string &relativeTo)
const CVersion &	getVersion () const
bool	setModel (CModel *pModel)
CModel *	getModel () const
bool	haveModel () const
bool	freeModel ()
bool	setFunctionList (CCopasiVectorN< CEvaluationTree > *pFunctionList)
CCopasiVectorN< CEvaluationTree > *	getFunctionList () const
bool	haveFunctionList () const
bool	freeFunctionList ()
bool	setTaskList (CCopasiVectorN< CCopasiTask > *pTaskList)
bool	setDatamodel (CCopasiDataModel *pDataModel)
CCopasiVectorN< CCopasiTask > *	getTaskList () const
bool	haveTaskList () const
bool	freeTaskList ()
bool	setPlotList (COutputDefinitionVector *pPlotList)
COutputDefinitionVector *	getPlotList () const
bool	havePlotList () const
bool	freePlotList ()
bool	setReportList (CReportDefinitionVector *pReportList)
CReportDefinitionVector *	getReportList () const
bool	haveReportList () const
bool	freeReportList ()
bool	setGUI (SCopasiXMLGUI *pGUI)
SCopasiXMLGUI *	getGUI () const
bool	haveGUI () const
bool	freeGUI ()
bool	setLayoutList (const CListOfLayouts &reportList)
CListOfLayouts *	getLayoutList () const
bool	haveLayoutList () const
bool	freeLayoutList ()

---

Constructor & Destructor Documentation

CCopasiXML::CCopasiXML

(

)

Constructor

CCopasiXML class. This class implements a CCopasiXMLInterface to the COPASI XML specified in http://www.copasi.org/schema/copasi.xsd

Created for COPASI by Stefan Hoops 2003 Copyright Stefan Hoops

CCopasiXML::~CCopasiXML

(

)

Destructor

---

Member Function Documentation

bool CCopasiXML::freeFunctionList

(

)

Free the function list.

Returns:

bool success

bool CCopasiXML::freeGUI

(

)

Free the GUI.

Returns:

bool success

bool CCopasiXML::freeLayoutList

(

)

Free the layout list.

Returns:

bool success

bool CCopasiXML::freeModel

(

)

Free the model.

Returns:

bool success

bool CCopasiXML::freePlotList

(

)

Free the plot list.

Returns:

bool success

bool CCopasiXML::freeReportList

(

)

Free the report list.

Returns:

bool success

bool CCopasiXML::freeTaskList

(

)

Free the task list.

Returns:

bool success

CCopasiVectorN< CEvaluationTree > * CCopasiXML::getFunctionList

(

)

const

Retreive the function list.

Returns:

CCopasiVectorN< CEvaluationTree > * pFunctionList

SCopasiXMLGUI * CCopasiXML::getGUI

(

)

const

Retreive the SCopasiXMLGUI.

Returns:

SCopasiXMLGUI * pGUI

CListOfLayouts * CCopasiXML::getLayoutList

(

)

const

Retreive the layout list.

Returns:

CListOfLayouts * layoutList

CModel * CCopasiXML::getModel

(

)

const

Retreive the model.

Returns:

CModel * pModel

COutputDefinitionVector * CCopasiXML::getPlotList

(

)

const

Retreive the plot list.

Returns:

COutputDefinitionVector * plotList

CReportDefinitionVector * CCopasiXML::getReportList

(

)

const

Retreive the report list.

Returns:

CReportDefinitionVector * reportList

CCopasiVectorN< CCopasiTask > * CCopasiXML::getTaskList

(

)

const

Retreive the task list.

Returns:

CCopasiVectorN< CCopasiTask > * taskList

const CVersion & CCopasiXML::getVersion

(

)

const

Retrieve the version of the current XML file. Before any load operation this contains the COPASI schema version supported by the writer. After load it contains the schema version of the loaded file.

Returns:

const CVersion & version

bool CCopasiXML::haveFunctionList

(

)

const

Retreive whether the XML contains a function list.

Returns:

bool haveFunctionList

bool CCopasiXML::haveGUI

(

)

const

Retreive whether the XML contains a GUI.

Returns:

bool have GUI

bool CCopasiXML::haveLayoutList

(

)

const

Retreive whether the XML contains a layout list.

Returns:

bool haveLayoutList

bool CCopasiXML::haveModel

(

)

const

Retreive whether the XML contains a model.

Returns:

bool have Model

bool CCopasiXML::havePlotList

(

)

const

Retreive whether the XML contains a plot list.

Returns:

bool havePlotList

bool CCopasiXML::haveReportList

(

)

const

Retreive whether the XML contains a report list.

Returns:

bool haveReportList

bool CCopasiXML::haveTaskList

(

)

const

Retreive whether the XML contains a task list.

Returns:

bool haveTaskList

bool CCopasiXML::load	(	std::istream &	is,
		const std::string &	relativeTo
	)		[virtual]

Load information from a given istream.

Parameters:

std::istream	& is
const	std::string & relativeTo

Returns:

bool success

Implements CCopasiXMLInterface.

bool CCopasiXML::save	(	std::ostream &	os,
		const std::string &	relativeTo
	)		[virtual]

Save information to a given ostream.

Parameters:

std::ostream	& os
const	std::string & relativeTo

Returns:

bool success

Implements CCopasiXMLInterface.

bool CCopasiXML::setDatamodel

(

CCopasiDataModel *

pDataModel

)

Set the datamodel.

Parameters:

CCopasiDataModel*

pDataModel

Returns:

bool success

bool CCopasiXML::setFunctionList

(

CCopasiVectorN< CEvaluationTree > *

pFunctionList

)

Set the function list.

Parameters:

CopasiVectorN<

CEvaluationTree > * pFunctionList

Returns:

bool success

bool CCopasiXML::setGUI

(

SCopasiXMLGUI *

pGUI

)

Set the GUI.

Parameters:

SCopasiXMLGUI

*pGUI

Returns:

bool success

bool CCopasiXML::setLayoutList

(

const CListOfLayouts &

reportList

)

Set the layout list.

Parameters:

const

CListOfLayouts & reportList

Returns:

bool success

bool CCopasiXML::setModel

(

CModel *

pModel

)

Set the model.

Parameters:

CModel

* pModel

Returns:

bool success

bool CCopasiXML::setPlotList

(

COutputDefinitionVector *

pPlotList

)

Set the plot list.

Parameters:

COutputDefinitionVector

* pPlotList

Returns:

bool success

bool CCopasiXML::setReportList

(

CReportDefinitionVector *

pReportList

)

Set the report list.

Parameters:

CReportDefinitionVector

*pReportList

Returns:

bool success

bool CCopasiXML::setTaskList

(

CCopasiVectorN< CCopasiTask > *

pTaskList

)

Set the task list.

Parameters:

CCopasiVectorN<

CCopasiTask > *pTaskList

Returns:

bool success

---

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

• copasi/xml/CCopasiXML.h
• copasi/xml/CCopasiXML.cpp