COPASI API  4.40.278
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CCopasiXMLInterface Class Referenceabstract

#include <CCopasiXMLInterface.h>

Inheritance diagram for CCopasiXMLInterface:
[legend]

Classes

class  DBL
 

Public Types

enum  EncodingType { none = 0 , standard , attribute , character }
 

Public Member Functions

 CCopasiXMLInterface ()
 
bool load (const std::string &fileName, const std::string &relativeTo)
 
virtual bool load (std::istream &is, const std::string &relativeTo)=0
 
bool save (const std::string &fileName, const std::string &relativeTo)
 
virtual bool save (std::ostream &os, const std::string &relativeTo)=0
 
virtual ~CCopasiXMLInterface ()
 

Static Public Member Functions

static std::string encode (const std::string &str, const EncodingType &type=standard)
 
static std::string utf8 (const std::string &str)
 

Protected Member Functions

bool endSaveElement (const std::string &name)
 
bool saveData (const std::string &data)
 
bool saveElement (const std::string &name, CXMLAttributeList &attributeList)
 
bool saveParameter (const CCopasiParameter &parameter)
 
bool saveParameterGroup (const std::vector< CCopasiParameter * > &group)
 
bool saveXhtml (const std::string &xhtml)
 
bool startSaveElement (const std::string &name)
 
bool startSaveElement (const std::string &name, CXMLAttributeList &attributeList)
 

Protected Attributes

std::string mIndent
 
std::istream * mpIstream
 
std::ostream * mpOstream
 
std::string mPWD
 

Member Enumeration Documentation

◆ EncodingType

enum CCopasiXMLInterface::EncodingType

Enumeration of encoding type.

Enumerator
none 
standard 
attribute 
character 

Constructor & Destructor Documentation

◆ CCopasiXMLInterface()

CCopasiXMLInterface::CCopasiXMLInterface ( )

Constructor.

◆ ~CCopasiXMLInterface()

CCopasiXMLInterface::~CCopasiXMLInterface ( )
virtual

Destructor.

Member Function Documentation

◆ encode()

std::string CCopasiXMLInterface::encode ( const std::string &  str,
const EncodingType &  type = standard 
)
static

Encode a given string to a valid XML string

Parameters
conststd::string & str
Returns
std::string encoded

References attribute, character, encodeATTRIBUTE(), encodeCHARACTER(), encodeNONE(), encodeSTD(), none, and standard.

Referenced by CXMLAttributeList::add(), CMathMl::fixName(), CXMLParser::onCharacterData(), MiriamAnnotationHandler::processEnd(), UnsupportedAnnotationHandler::processEnd(), CommentHandler::processStart(), MiriamAnnotationHandler::processStart(), UnsupportedAnnotationHandler::processStart(), saveData(), CXMLAttributeList::set(), and CXMLAttributeList::setValue().

◆ endSaveElement()

bool CCopasiXMLInterface::endSaveElement ( const std::string &  name)
protected

End saving an XML element to the ostream started by startSaveElement.

Parameters
conststd::string & name
Returns
bool success

References mIndent, and mpOstream.

Referenced by CCopasiXML::save(), CCopasiXML::saveAnnotation(), CCopasiXML::saveBoundingBox(), CCopasiXML::saveCurve(), CCopasiXML::saveCurveElements(), CCopasiXML::saveFunctionList(), CCopasiXML::saveGlobalRenderInformation(), CCopasiXML::saveGlobalStyle(), CCopasiXML::saveGroupElement(), CCopasiXML::saveGUI(), CCopasiXML::saveLayoutList(), CCopasiXML::saveLinearGradient(), CCopasiXML::saveLineEnding(), CCopasiXML::saveListOfGlobalRenderInformation(), CCopasiXML::saveListOfLocalRenderInformation(), CCopasiXML::saveLocalRenderInformation(), CCopasiXML::saveLocalStyle(), CCopasiXML::saveModel(), CCopasiXML::saveModelParameter(), CCopasiXML::saveModelParameterSets(), saveParameter(), CCopasiXML::savePlotList(), CCopasiXML::savePolygonElement(), CCopasiXML::saveRadialGradient(), CCopasiXML::saveRenderCurveElement(), CCopasiXML::saveRenderInformationDefinitionElements(), CCopasiXML::saveRenderTextElement(), CCopasiXML::saveReportList(), CCopasiXML::saveReportSection(), CCopasiXML::saveSBMLReference(), CCopasiXML::saveTaskList(), and CCopasiXML::saveUnitDefinitionList().

◆ load() [1/2]

bool CCopasiXMLInterface::load ( const std::string &  fileName,
const std::string &  relativeTo 
)

Load information from a file.

Parameters
conststd::string & fileName
conststd::string & relativeTo
Returns
bool success

References CLocaleString::fromUtf8(), load(), and mPWD.

◆ load() [2/2]

virtual bool CCopasiXMLInterface::load ( std::istream &  is,
const std::string &  relativeTo 
)
pure virtual

Load information from a given istream.

Parameters
std::istream& is
conststd::string & relativeTo
Returns
bool success

Implemented in CConfigurationFile::CXML, and CCopasiXML.

Referenced by load().

◆ save() [1/2]

bool CCopasiXMLInterface::save ( const std::string &  fileName,
const std::string &  relativeTo 
)

Save information to a file.

Parameters
conststd::string & fileName
conststd::string & relativeTo
Returns
bool success

References CLocaleString::fromUtf8(), mPWD, and save().

◆ save() [2/2]

virtual bool CCopasiXMLInterface::save ( std::ostream &  os,
const std::string &  relativeTo 
)
pure virtual

Save information to a given ostream.

Parameters
std::ostream& os
conststd::string & relativeTo
Returns
bool success

Implemented in CCopasiXML, and CConfigurationFile::CXML.

Referenced by save().

◆ saveData()

bool CCopasiXMLInterface::saveData ( const std::string &  data)
protected

Save CDATA to the ostream

Parameters
conststd::string & data
Returns
bool success

References character, encode(), mIndent, and mpOstream.

Referenced by CCopasiXML::saveFunctionList(), CCopasiXML::saveModel(), CCopasiXML::saveModelParameter(), saveParameter(), CCopasiXML::saveRenderTextElement(), CCopasiXML::saveUnitDefinitionList(), and saveXhtml().

◆ saveElement()

bool CCopasiXMLInterface::saveElement ( const std::string &  name,
CXMLAttributeList &  attributeList 
)
protected

Save an XML element to the ostream

Parameters
conststd::string & name
CXMLAttributeList& attributeList
Returns
bool success

References mIndent, and mpOstream.

Referenced by CCopasiXML::saveColorDefinition(), CCopasiXML::saveDimensions(), CCopasiXML::saveEllipseElement(), CCopasiXML::saveFunctionList(), CCopasiXML::saveGradientStop(), CCopasiXML::saveGUI(), CCopasiXML::saveImageElement(), CCopasiXML::saveLayoutList(), CCopasiXML::saveModel(), CCopasiXML::saveModelParameter(), saveParameter(), CCopasiXML::savePlotList(), CCopasiXML::savePosition(), CCopasiXML::saveRectangleElement(), CCopasiXML::saveRenderPoint(), CCopasiXML::saveReportList(), CCopasiXML::saveReportSection(), CCopasiXML::saveSBMLReference(), and CCopasiXML::saveTaskList().

◆ saveParameter()

bool CCopasiXMLInterface::saveParameter ( const CCopasiParameter &  parameter)
protected

Save a Parameter.

Parameters
constCCopasiParameter & parameter
Returns
bool success

References CXMLAttributeList::add(), CCopasiParameter::BOOL, C_FLOAT64, C_INT32, CCopasiParameter::CN, CCopasiParameter::DOUBLE, endSaveElement(), CCopasiParameter::EXPRESSION, CCopasiParameter::FILE, CDataObject::getObjectName(), CCopasiParameter::getType(), CCopasiParameter::getValue(), CCopasiParameter::GROUP, CCopasiParameter::INT, CCopasiParameter::INVALID, CDirEntry::isRelativePath(), CCopasiParameter::KEY, CDirEntry::makePathRelative(), mPWD, saveData(), saveElement(), saveParameterGroup(), CXMLAttributeList::skip(), startSaveElement(), CCopasiParameter::STRING, CCopasiParameter::UDOUBLE, CCopasiParameter::UINT, CCopasiMessage::WARNING, and CCopasiParameter::XMLType.

Referenced by saveParameterGroup().

◆ saveParameterGroup()

bool CCopasiXMLInterface::saveParameterGroup ( const std::vector< CCopasiParameter * > &  group)
protected

Save a Parameter Group.

Parameters
constCCopasiParameterGroup::parameterGroup & group
Returns
bool success

References saveParameter().

Referenced by saveParameter(), CCopasiXML::savePlotList(), and CCopasiXML::saveTaskList().

◆ saveXhtml()

bool CCopasiXMLInterface::saveXhtml ( const std::string &  xhtml)
protected

Save xhtml to the ostream

Parameters
conststd::string & xhtml
Returns
bool success

References mIndent, mpOstream, and saveData().

Referenced by CCopasiXML::saveAnnotation(), CCopasiXML::saveReportList(), and CCopasiXML::saveReportSection().

◆ startSaveElement() [1/2]

bool CCopasiXMLInterface::startSaveElement ( const std::string &  name)
protected

Start saving an XML element to the ostream. Call endSaveElement to conclude.

Parameters
conststd::string & name
Returns
bool success

References mIndent, and mpOstream.

Referenced by CCopasiXML::save(), CCopasiXML::saveAnnotation(), CCopasiXML::saveBoundingBox(), CCopasiXML::saveCurve(), CCopasiXML::saveCurveElements(), CCopasiXML::saveFunctionList(), CCopasiXML::saveGlobalRenderInformation(), CCopasiXML::saveGlobalStyle(), CCopasiXML::saveGroupElement(), CCopasiXML::saveGUI(), CCopasiXML::saveLayoutList(), CCopasiXML::saveLinearGradient(), CCopasiXML::saveLineEnding(), CCopasiXML::saveListOfGlobalRenderInformation(), CCopasiXML::saveListOfLocalRenderInformation(), CCopasiXML::saveLocalRenderInformation(), CCopasiXML::saveLocalStyle(), CCopasiXML::saveModel(), CCopasiXML::saveModelParameter(), CCopasiXML::saveModelParameterSets(), saveParameter(), CCopasiXML::savePlotList(), CCopasiXML::savePolygonElement(), CCopasiXML::saveRadialGradient(), CCopasiXML::saveRenderCurveElement(), CCopasiXML::saveRenderInformationDefinitionElements(), CCopasiXML::saveRenderTextElement(), CCopasiXML::saveReportList(), CCopasiXML::saveReportSection(), CCopasiXML::saveSBMLReference(), CCopasiXML::saveTaskList(), and CCopasiXML::saveUnitDefinitionList().

◆ startSaveElement() [2/2]

bool CCopasiXMLInterface::startSaveElement ( const std::string &  name,
CXMLAttributeList &  attributeList 
)
protected

Start saving an XML element to the ostream. Call endSaveElement to conclude.

Parameters
conststd::string & name
CXMLAttributeList& attributeList
Returns
bool success

References mIndent, and mpOstream.

◆ utf8()

std::string CCopasiXMLInterface::utf8 ( const std::string &  str)
static

Encode a given string to a valid XML string

Parameters
constC_FLOAT64 & dbl
Returns
std::string encoded Encode a given string to a utf-8 string
Parameters
conststd::string & str
Returns
std::string encoded

Referenced by CMIRIAMResourceObject::unescapeId().

Member Data Documentation

◆ mIndent

std::string CCopasiXMLInterface::mIndent
protected

Indent

Referenced by endSaveElement(), saveData(), saveElement(), CCopasiXML::saveModel(), saveXhtml(), and startSaveElement().

◆ mpIstream

std::istream* CCopasiXMLInterface::mpIstream
protected

A pointer to the input stream

Referenced by CCopasiXML::load().

◆ mpOstream

std::ostream* CCopasiXMLInterface::mpOstream
protected

A pointer to the output stream

Referenced by endSaveElement(), CCopasiXML::save(), CCopasiXML::saveAnnotation(), saveData(), saveElement(), CCopasiXML::saveModel(), CCopasiXML::saveModelParameterSets(), saveXhtml(), and startSaveElement().

◆ mPWD

std::string CCopasiXMLInterface::mPWD
protected

The filename if available

Referenced by load(), CCopasiXML::load(), save(), CCopasiXML::save(), CCopasiXML::saveModelParameterSets(), saveParameter(), CCopasiXML::saveSBMLReference(), and CCopasiXML::saveTaskList().

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