ml::XMLPersistenceOutputStream Class Reference

Implementation for AbstractPersistenceOutputStream using Xerces DOM Parser. More...

#include <mlXMLPersistenceStream.h>

Inheritance diagram for ml::XMLPersistenceOutputStream:

List of all members.

Public Member Functions
	XMLPersistenceOutputStream ()
	this constructor creates a new XML document that can be written afterwards with writeToFile or writeToString
	XMLPersistenceOutputStream (DOMElement *container)
	this constructor takes an existing XML element - everything will be written relative to this element
virtual	~XMLPersistenceOutputStream ()
	this will free the XML document if the first constructor was used
virtual void	writeToFile (const std::string &fileName)
	Writes the complete tree to a file.
virtual void	writeToString (std::string &str)
	Writes the subtree rooted by this node to a string.
virtual bool	isBinary () const
	overriden methods
virtual void	writeString (const char *name, const std::string &value)
	Abstract writing method that needs to be implemented by derived classes.
virtual void	writeData (const void *data, size_t len, const char *name)
	Write binary data to stream.
virtual void	startListImpl (const char *name, const char *xmlItemName, bool xmlSuppressScope)
	Abstract methods called by above methods, need to be implemented in derived classes.
virtual void	endListImpl ()
virtual void	startStructImpl (const char *name)
virtual void	endStructImpl ()
virtual void	setObjectID (int id)
	Implementation of Base object persistence, set attribute on currently open struct (implementation hint: these can be stored unnamed, if they are read or not is always deduced from the current state of the persistence stream)
virtual void	setObjectType (const char *type)
	base type name
virtual void	setObjectVersion (int version)
	persistence version
virtual void	writeValues (const char *name, const MLint32 *values, size_t n, bool fixedList)
	Abstract writing methods that need to be implemented by derived classes.
virtual void	writeValues (const char *name, const MLuint32 *values, size_t n, bool fixedList)
virtual void	writeValues (const char *name, const MLint64 *values, size_t n, bool fixedList)
virtual void	writeValues (const char *name, const MLuint64 *values, size_t n, bool fixedList)
virtual void	writeValues (const char *name, const MLfloat *values, size_t n, bool fixedList)
virtual void	writeValues (const char *name, const MLdouble *values, size_t n, bool fixedList)

---

Detailed Description

Implementation for AbstractPersistenceOutputStream using Xerces DOM Parser.

Definition at line 59 of file mlXMLPersistenceStream.h.

---

Constructor & Destructor Documentation

ml::XMLPersistenceOutputStream::XMLPersistenceOutputStream

(

)

this constructor creates a new XML document that can be written afterwards with writeToFile or writeToString

ml::XMLPersistenceOutputStream::XMLPersistenceOutputStream

(

DOMElement *

container

)

this constructor takes an existing XML element - everything will be written relative to this element

virtual ml::XMLPersistenceOutputStream::~XMLPersistenceOutputStream

(

)

[virtual]

this will free the XML document if the first constructor was used

---

Member Function Documentation

virtual void ml::XMLPersistenceOutputStream::endListImpl

(

)

[protected, virtual]

Implements ml::AbstractPersistenceStream.

virtual void ml::XMLPersistenceOutputStream::endStructImpl

(

)

[protected, virtual]

Implements ml::AbstractPersistenceStream.

virtual bool ml::XMLPersistenceOutputStream::isBinary

(

)

const [inline, virtual]

overriden methods

Implements ml::AbstractPersistenceStream.

Definition at line 81 of file mlXMLPersistenceStream.h.

virtual void ml::XMLPersistenceOutputStream::setObjectID

(

int

id

)

[protected, virtual]

Implementation of Base object persistence, set attribute on currently open struct (implementation hint: these can be stored unnamed, if they are read or not is always deduced from the current state of the persistence stream)

unique id for each pointer value - currently unused

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::setObjectType

(

const char *

type

)

[protected, virtual]

base type name

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::setObjectVersion

(

int

version

)

[protected, virtual]

persistence version

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::startListImpl	(	const char *	name,
		const char *	xmlItemName,
		bool	xmlSuppressScope
	)		[protected, virtual]

Abstract methods called by above methods, need to be implemented in derived classes.

Implementors don't need to do error checking. xmlItemName and xmlSuppressScope only need to be regarded for XML format:

Implements ml::AbstractPersistenceStream.

virtual void ml::XMLPersistenceOutputStream::startStructImpl

(

const char *

name

)

[protected, virtual]

Implements ml::AbstractPersistenceStream.

virtual void ml::XMLPersistenceOutputStream::writeData	(	const void *	data,
		size_t	len,
		const char *	name
	)		[virtual]

Write binary data to stream.

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeString	(	const char *	name,
		const std::string &	value
	)		[virtual]

Abstract writing method that needs to be implemented by derived classes.

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeToFile

(

const std::string &

fileName

)

[virtual]

Writes the complete tree to a file.

virtual void ml::XMLPersistenceOutputStream::writeToString

(

std::string &

str

)

[virtual]

Writes the subtree rooted by this node to a string.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLuint32 *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLint32 *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Abstract writing methods that need to be implemented by derived classes.

fixedList tells the stream if the number of elements to write is fixed (and known when reading) or if it needs to be stored in the stream.

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLdouble *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLuint64 *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLint64 *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Implements ml::AbstractPersistenceOutputStream.

virtual void ml::XMLPersistenceOutputStream::writeValues	(	const char *	name,
		const MLfloat *	values,
		size_t	n,
		bool	fixedList
	)		[protected, virtual]

Implements ml::AbstractPersistenceOutputStream.

---

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

• MeVisLab/Standard/Sources/ML/MLParser/mlXMLParser/mlXMLPersistenceStream.h