CCopasiXMLParser Class Reference

#include <CCopasiXMLParser.h>

Inheritance diagram for CCopasiXMLParser:

List of all members.

Classes
class	AdditionalGOElement
class	AssignmentElement
class	BodyElement
class	CallParameterElement
class	ChannelSpecElement
class	CharacterDataElement
class	CommentElement
class	CompartmentElement
class	CompartmentGlyphElement
class	ComplexElement
class	ConstantElement
class	COPASIElement
class	CurveElement
class	EventElement
class	FooterElement
class	FunctionElement
class	GUIElement
class	HeaderElement
class	InitialStateElement
class	KineticLawElement
class	LayoutElement
class	ListOfAdditionalGOsElement
class	ListOfAssignmentsElement
class	ListOfCallParametersElement
class	ListOfChannelsElement
class	ListOfCompartmentGlyphsElement
class	ListOfCompartmentsElement
class	ListOfConstantsElement
class	ListOfEventsElement
class	ListOfFunctionsElement
class	ListOfLayoutsElement
class	ListOfMetabGlyphsElement
class	ListOfMetaboliteReferenceGlyphsElement
class	ListOfMetabolitesElement
class	ListOfModelValuesElement
class	ListOfModifiersElement
class	ListOfParameterDescriptionsElement
class	ListOfPlotItemsElement
class	ListOfPlotsElement
class	ListOfProductsElement
class	ListOfReactionGlyphsElement
class	ListOfReactionsElement
class	ListOfReportsElement
class	ListOfSlidersElement
class	ListOfSubstratesElement
class	ListOfTasksElement
class	ListOfTextGlyphsElement
class	MathMLElement
class	MetaboliteElement
class	MetaboliteGlyphElement
class	MetaboliteReferenceGlyphElement
class	MethodElement
class	MiriamAnnotationElement
class	ModelElement
class	ModelValueElement
class	ModifierElement
class	ObjectElement
class	ParameterDescriptionElement
class	ParameterElement
class	ParameterGroupElement
class	ParameterTextElement
class	PlotItemElement
class	PlotSpecificationElement
class	ProductElement
class	ReactionElement
class	ReactionGlyphElement
class	ReportElement
class	ReportInstanceElement
class	SBMLMapElement
class	SBMLReferenceElement
class	SliderElement
class	SourceParameterElement
class	StateTemplateElement
class	StateTemplateVariableElement
class	SubstrateElement
class	TableElement
class	TaskElement
class	TextGlyphElement
class	UnknownElement
Public Member Functions
	CCopasiXMLParser (CVersion &version)
	~CCopasiXMLParser ()
virtual void	onStartElement (const XML_Char *pszName, const XML_Char **papszAttrs)
virtual void	onEndElement (const XML_Char *pszName)
void	setDatamodel (CCopasiDataModel *pDataModel)
void	setFunctionList (CCopasiVectorN< CEvaluationTree > *pFunctionList)
void	enableCharacterDataHandler (bool fEnable=true)
virtual void	onCharacterData (const XML_Char *pszData, int nLength)
std::string	getCharacterData (const std::string &toBeStripped="", const std::string &join=" ")
void	pushElementHandler (CXMLElementHandler< CCopasiXMLParser, SCopasiXMLParserCommon > *elementHandler)
void	popElementHandler ()
CModel *	getModel () const
CReportDefinitionVector *	getReportList () const
CCopasiVectorN< CCopasiTask > *	getTaskList () const
COutputDefinitionVector *	getPlotList () const
void	setGUI (SCopasiXMLGUI *pGUI)
void	setLayoutList (CListOfLayouts *pLayoutList)
CListOfLayouts *	getLayoutList () const
const CCopasiParameterGroup *	getCurrentGroup () const
const CCopasiObject *	getObjectFromName (const std::string &cn) const
Public Attributes
UnknownElement	mUnknownElement
CharacterDataElement	mCharacterDataElement
CommentElement	mCommentElement
MiriamAnnotationElement	mMiriamAnnotationElement

---

Constructor & Destructor Documentation

CCopasiXMLParser::CCopasiXMLParser

(

CVersion &

version

)

Public constructor

Parameters:

CVersion

& version

CCopasiXMLParser::~CCopasiXMLParser

(

)

Destructor

---

Member Function Documentation

void CCopasiXMLParser::enableCharacterDataHandler

(

bool

fEnable = true

)

Enable/Disable the character data handler

Parameters:

bool	fEnable (Default: true)

Reimplemented from CExpatTemplate< CExpat >.

std::string CCopasiXMLParser::getCharacterData	(	const std::string &	toBeStripped = "",
		const std::string &	join = " "
	)

Retrieve the data. Any sequence of toBeStripped characters is replaced by a single join character. The default is no stripping.

Parameters:

const	std::string & toBeStripped (default: "")
const	std::string & join (default: " ")

Returns:

std::string data

const CCopasiParameterGroup * CCopasiXMLParser::getCurrentGroup

(

)

const

Retrieve a pointer to the current group if available

Returns:

const CCopasiParameterGroup * currentGroup

CListOfLayouts * CCopasiXMLParser::getLayoutList

(

)

const

Retrieve the list of loaded layouts

Returns:

CListOfLayouts * pLayoutList

CModel * CCopasiXMLParser::getModel

(

)

const

Retrieve the loaded model functions

Returns:

CModel * pModel

const CCopasiObject * CCopasiXMLParser::getObjectFromName

(

const std::string &

cn

)

const

Retrieve an object by its CN within the context of the parser

Parameters:

const

std::string & cn

Returns:

const CCopasiObject * pObject

COutputDefinitionVector * CCopasiXMLParser::getPlotList

(

)

const

Retrieve the list of loaded functions

Returns:

COutputDefinitionVector * pPlotList

CReportDefinitionVector * CCopasiXMLParser::getReportList

(

)

const

Retrieve the list of loaded reports

Returns:

CReportDefinitionVector * pReportList

CCopasiVectorN< CCopasiTask > * CCopasiXMLParser::getTaskList

(

)

const

Retrieve the list of loaded functions

Returns:

CCopasiVectorN< CTask > * pTaskList

void CCopasiXMLParser::onCharacterData	(	const XML_Char *	pszData,
		int	nLength
	)		[virtual]

Character data handler

Parameters:

const	XML_Char *pszData
int	nLength

Reimplemented from CExpat.

void CCopasiXMLParser::onEndElement

(

const XML_Char *

pszName

)

[virtual]

End element handler

Parameters:

const

XML_Char *pszName

Reimplemented from CExpat.

void CCopasiXMLParser::onStartElement	(	const XML_Char *	pszName,
		const XML_Char **	papszAttrs
	)		[virtual]

Start element handler

Parameters:

const	XML_Char *pszName
const	XML_Char **papszAttrs

Reimplemented from CExpat.

void CCopasiXMLParser::popElementHandler

(

)

Pop the element handler form the stack.

void CCopasiXMLParser::pushElementHandler

(

CXMLElementHandler< CCopasiXMLParser, SCopasiXMLParserCommon > *

elementHandler

)

Push the element handler on the stack.

Parameters:

CXMLHandler<

CCopasiXMLParser > elementHandler

void CCopasiXMLParser::setDatamodel

(

CCopasiDataModel *

pDataModel

)

Set the datamodel.

Parameters:

CCopasiDataModel*

pDataModel

void CCopasiXMLParser::setFunctionList

(

CCopasiVectorN< CEvaluationTree > *

pFunctionList

)

Set the list of loaded functions

Parameters:

CCopasiVectorN<

CEvaluationTree > * pFunctionList

void CCopasiXMLParser::setGUI

(

SCopasiXMLGUI *

pGUI

)

Set the GUI information to be saved

Parameters:

SCopasiXMLGUI

* pGUI

void CCopasiXMLParser::setLayoutList

(

CListOfLayouts *

pLayoutList

)

Set the list of loaded layouts

Parameters:

CListOfLayouts

* pLayoutList

---

Member Data Documentation

CharacterDataElement CCopasiXMLParser::mCharacterDataElement

The character data element handler

CommentElement CCopasiXMLParser::mCommentElement

The comment element handler

MiriamAnnotationElement CCopasiXMLParser::mMiriamAnnotationElement

The Miriam Annotation Element handler

UnknownElement CCopasiXMLParser::mUnknownElement

The unknown element handler

---

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

• copasi/xml/CCopasiXMLParser.h
• copasi/xml/CCopasiXMLParser.cpp