BIAS::XMLBase Class Reference

Base class with interface for xml output. More...

#include <Base/Common/XMLBase.hh>

Inheritance diagram for BIAS::XMLBase:

Public Member Functions
xmlNodePtr	XMLAdd (const xmlNodePtr Node, XMLIO &XMLObject) const
	call this to add the class to a node of a given xml tree More...
virtual int	XMLGetClassName (std::string &TopLevelTag, double &Version) const =0
	derived classes must implement this, so that it returns the name of the class for the top level tag in the XML file More...
virtual int	XMLIn (const xmlNodePtr Node, XMLIO &XMLObject)=0
	derived classes must implement this to read everything in Node into (*this). More...
virtual int	XMLOut (const xmlNodePtr Node, XMLIO &XMLObject) const =0
	derived classes must implement this to write the code of (*this) into the XML tree. More...
int	XMLRead (const std::string &Filename)
	derived classes must implement the function XMLIn which is called by this function XMLRead to read everything with name Filename into (*this). More...
int	XMLReadFromString (const std::string &str)
	reconstruct xml tree from string More...
int	XMLWrite (const std::string &Filename, int CompressionLevel=0, bool AutoAddCompressionSuffix=true, std::string encoding="UTF-8") const
	call this to add the class to a new xml tree and write it to the file Filename. More...
int	XMLWriteToString (std::string &str, std::string encoding="UTF-8") const
	serialize xml tree to string More...
virtual	~XMLBase ()

Detailed Description

Base class with interface for xml output.

All classes with xml i/o support should be derived from this class. You can then call XMLWrite to write the object to an XML file or XMLAdd(n) to attach the object to a node n of a given xml structure. For this to work you must:

• Override XMLGetTopLevelName such that it returns something identifying the class, e.g. "FeaturePoint". XMLAdd and XMLWrite use this function to generate the toplevel node of you object.
• Override XMLFill, such that it fills the XML code of (*this) into a tree, where the top level node is already created Given a valid xml file, you can call XMLRead to read the xml file into the current object, this calls your specialization of XMLReadObject

This class is empty if no XML2 support is available.

Author

koeser 08/2004

Examples:

ExampleXMLBase.cpp.

Definition at line 56 of file XMLBase.hh.

Constructor & Destructor Documentation

virtual BIAS::XMLBase::~XMLBase ( )

inlinevirtual

Definition at line 59 of file XMLBase.hh.

Member Function Documentation

xmlNodePtr XMLBase::XMLAdd	(	const xmlNodePtr	Node,
		XMLIO &	XMLObject
	)		const

call this to add the class to a node of a given xml tree

Attention

interface changed 3/2008: return value now nodeptr of added node!

Definition at line 26 of file XMLBase.cpp.

References BIAS::XMLIO::addAttribute(), and BIAS::XMLIO::addChildNode().

virtual int BIAS::XMLBase::XMLGetClassName ( std::string &  TopLevelTag, double &  Version  ) const

pure virtual

derived classes must implement this, so that it returns the name of the class for the top level tag in the XML file

Implemented in BIAS::ProjectionParametersBase, BIAS::ProjectionParametersPerspective, BIAS::ProjectionParametersDynamicLoad, BIAS::Projection, BIAS::PMatrix, BIAS::ProjectionParametersSpherical, BIAS::ProjectionParametersPerspectiveDepth, BIAS::ProjectionParametersSphericalFast, BIAS::ProjectionParametersProjective, BIAS::ProjectionParametersZoom, BIAS::LocalAffineFrame, BIAS::ProjectionParametersCylindric, BIAS::ProjectionParametersSphericalSimple, BIAS::Pose, BIAS::NodeInfoMap, BIAS::ProjectionParametersGreatCircles, BIAS::ProjectionParametersOrthographic, BIAS::ProjectionParametersBufferedRay, BIAS::NodeInfo, BIAS::SceneText, and BIAS::SceneTextScreen.

virtual int BIAS::XMLBase::XMLIn ( const xmlNodePtr  Node, XMLIO &  XMLObject  )

pure virtual

derived classes must implement this to read everything in Node into (*this).

Called by XMLRead of XMLBase.

Returns

0 on success, <0 on error

Implemented in BIAS::ProjectionParametersBase, BIAS::ProjectionParametersPerspective, BIAS::ProjectionParametersDynamicLoad, BIAS::Projection, BIAS::PMatrix, BIAS::ProjectionParametersSpherical, BIAS::ProjectionParametersPerspectiveDepth, BIAS::ProjectionParametersSphericalFast, BIAS::ProjectionParametersProjective, BIAS::ProjectionParametersZoom, BIAS::LocalAffineFrame, BIAS::ProjectionParametersCylindric, BIAS::ProjectionParametersSphericalSimple, BIAS::Pose, BIAS::NodeInfoMap, BIAS::ProjectionParametersGreatCircles, BIAS::ProjectionParametersOrthographic, BIAS::ProjectionParametersBufferedRay, BIAS::NodeInfo, BIAS::SceneText, and BIAS::SceneTextScreen.

virtual int BIAS::XMLBase::XMLOut ( const xmlNodePtr  Node, XMLIO &  XMLObject  ) const

pure virtual

derived classes must implement this to write the code of (*this) into the XML tree.

Called by XMLRead of XMLBase.

Parameters

node	always points to a node with a name given by the function XMLGetTopLevelName

Implemented in BIAS::ProjectionParametersBase, BIAS::ProjectionParametersPerspective, BIAS::ProjectionParametersDynamicLoad, BIAS::Projection, BIAS::PMatrix, BIAS::ProjectionParametersSpherical, BIAS::ProjectionParametersPerspectiveDepth, BIAS::ProjectionParametersSphericalFast, BIAS::ProjectionParametersProjective, BIAS::ProjectionParametersZoom, BIAS::LocalAffineFrame, BIAS::ProjectionParametersCylindric, BIAS::NodeInfoMap, BIAS::ProjectionParametersSphericalSimple, BIAS::Pose, BIAS::ProjectionParametersGreatCircles, BIAS::ProjectionParametersOrthographic, BIAS::NodeInfo, BIAS::ProjectionParametersBufferedRay, BIAS::SceneText, and BIAS::SceneTextScreen.

int XMLBase::XMLRead

(

const std::string &

Filename

)

derived classes must implement the function XMLIn which is called by this function XMLRead to read everything with name Filename into (*this).

Returns

0 on success, <0 on error

Examples:

ExampleCamera.cpp, ExampleMultisampleBlit.cpp, ExampleProjection.cpp, ExampleProjectionMapping.cpp, ExampleProjectionParametersPerspective.cpp, ExampleProjectionParametersProjective.cpp, ExampleProjectionParametersSpherical.cpp, ExampleTransformToCartesian.cpp, and ExampleUndistort.cpp.

Definition at line 78 of file XMLBase.cpp.

References BIAS::XMLIO::clear(), BIAS::XMLIO::getAttributeValueDouble(), BIAS::XMLIO::getNodeName(), and BIAS::XMLIO::read().

Referenced by BIAS::biasGLviewerGLUT::Init(), BIAS::SceneOpenSceneGraph::Load(), and BIAS::GLProjectionParametersPerspective::XMLRead().

int XMLBase::XMLReadFromString

(

const std::string &

str

)

reconstruct xml tree from string

Author

evers

Examples:

ExampleProjection.cpp.

Definition at line 111 of file XMLBase.cpp.

References BIAS::XMLIO::clear(), BIAS::XMLIO::getAttributeValueDouble(), BIAS::XMLIO::getNodeName(), and BIAS::XMLIO::ReadFromString().

Referenced by BIAS::IOUtils::GetProjection().

int XMLBase::XMLWrite	(	const std::string &	Filename,
		int	CompressionLevel = 0,
		bool	AutoAddCompressionSuffix = true,
		std::string	encoding = "UTF-8"
	)		const

call this to add the class to a new xml tree and write it to the file Filename.

Calls function XMLOut of derived class

Parameters

CompressionLevel

0..9 (0=off, 9=highest compression)

Examples:

ExampleProjection.cpp, ExampleProjectionParametersFactory.cpp, ExampleProjectionParametersPerspective.cpp, ExampleProjectionParametersProjective.cpp, and ExampleProjectionParametersSpherical.cpp.

Definition at line 40 of file XMLBase.cpp.

References BIAS::XMLIO::addAttribute(), BIAS::XMLIO::clear(), BIAS::XMLIO::create(), BIAS::XMLIO::SetCompression(), BIAS::XMLIO::SetEncoding(), and BIAS::XMLIO::write().

Referenced by BIAS::SphericalDepthPanorama::GetTriangleMesh(), BIAS::SceneOpenSceneGraph::Save(), BIAS::ScreenShotListener::StoreNextScreenShot_(), and BIAS::GLProjectionParametersPerspective::XMLWrite().

int XMLBase::XMLWriteToString	(	std::string &	str,
		std::string	encoding = "UTF-8"
	)		const

serialize xml tree to string

Author

evers

Examples:

ExampleProjection.cpp.

Definition at line 61 of file XMLBase.cpp.

References BIAS::XMLIO::addAttribute(), BIAS::XMLIO::clear(), BIAS::XMLIO::create(), BIAS::XMLIO::SetEncoding(), and BIAS::XMLIO::WriteToString().

---

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

• Base/Common/XMLBase.hh
• Base/Common/XMLBase.cpp