BSUtilities::xmlr Namespace Reference

all entities for reading an XML file More...

Classes
class	XmlReadError
	exception class More...
Functions
TiXmlHandle	xmlInit (const std::string &filename)
	initialize XML reading
void	xmlFinish (TiXmlHandle &element)
	finish XML reading
template<class X>
void	xmlLoad (const std::string &filename, X &obj)
	load xml data into an object

---

Detailed Description

all entities for reading an XML file

---

Function Documentation

void BSUtilities::xmlr::xmlFinish

(

TiXmlHandle &

element

)

finish XML reading

checks for the document, the XML element pointed to be the handle lives in and deletes that document; never attempt to use any contents of this document after calling this function.

Definition at line 67 of file xmlReader.cc.

Referenced by xmlLoad().

TiXmlHandle BSUtilities::xmlr::xmlInit

(

const std::string &

filename

)

initialize XML reading

uses TinyXml; if the file can not be loaded into the TiXmlDocument structure, an exception is thrown; the TiXmlDocument is generated by operator new, after you are done with the document, release memory with delete

Definition at line 48 of file xmlReader.cc.

Referenced by xmlLoad().

template<class X>

void BSUtilities::xmlr::xmlLoad	(	const std::string &	filename,
		X &	obj
	)			[inline]

load xml data into an object

data are loaded from a file with name filename, and stored in an object obj of type X; X must define a load function.

Definition at line 73 of file xmlReader.h.

References xmlFinish(), and xmlInit().

---