CConfigurationFile::CXML Class Reference

Inheritance diagram for CConfigurationFile::CXML:

Public Member Functions
	CXML ()
const CCopasiParameterGroup &	getConfiguration () const
virtual bool	load (std::istream &is, const std::string &relativeTo)
virtual bool	save (std::ostream &os, const std::string &relativeTo)
void	setConfiguration (const CCopasiParameterGroup &configuration)
	~CXML ()
Public Member Functions inherited from CCopasiXMLInterface
	CCopasiXMLInterface ()
bool	load (const std::string &fileName, const std::string &relativeTo)
bool	save (const std::string &fileName, const std::string &relativeTo)
virtual	~CCopasiXMLInterface ()

Private Attributes
CCopasiParameterGroup	mConfiguration

Additional Inherited Members
Public Types inherited from CCopasiXMLInterface
enum	EncodingType { none = 0 , standard , attribute , character }
Static Public Member Functions inherited from CCopasiXMLInterface
static std::string	encode (const std::string &str, const EncodingType &type=standard)
static std::string	utf8 (const std::string &str)
Protected Member Functions inherited from CCopasiXMLInterface
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 inherited from CCopasiXMLInterface
std::string	mIndent
std::istream *	mpIstream
std::ostream *	mpOstream
std::string	mPWD

Detailed Description

Class dealing with the loading and writing of the XML configuration file.

Constructor & Destructor Documentation

CXML()

CConfigurationFile::CXML::CXML

(

)

Constructor

References CCopasiParameterGroup::assertGroup(), and mConfiguration.

~CXML()

CConfigurationFile::CXML::~CXML

(

)

Destructor

Member Function Documentation

getConfiguration()

const CCopasiParameterGroup & CConfigurationFile::CXML::getConfiguration

(

)

const

Retrieve the configuration contents

Returns

const CConfigurationFile & configuration

Referenced by CConfigurationFile::load().

load()

bool CConfigurationFile::CXML::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.

References BUFFER_SIZE, CCopasiParameterGroup::clear(), CExpatTemplate< CType >::getCurrentColumnNumber(), CXMLParser::getCurrentGroup(), CExpatTemplate< CType >::getCurrentLineNumber(), CExpatTemplate< CType >::getErrorString(), COptions::getValue(), MCConfiguration, MCXML, CExpatTemplate< CType >::parse(), CCopasiMessage::RAW, CDataObject::setObjectName(), and CCopasiMessage::WARNING.

save()

bool CConfigurationFile::CXML::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.

References CVersion::getVersion(), UTCTimeStamp(), and CVersion::VERSION.

setConfiguration()

void CConfigurationFile::CXML::setConfiguration

(

const CCopasiParameterGroup &

configuration

)

Set the configuration contents

Parameters

const

CConfigurationFile & configuration

Referenced by CConfigurationFile::save().

Member Data Documentation

mConfiguration

CCopasiParameterGroup CConfigurationFile::CXML::mConfiguration

private

A pointer to the CCopasiParameterGroup containing the information

Referenced by CXML().

---

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

• CConfigurationFile.h
• CConfigurationFile.cpp