ml::XMLPersistenceInputStream Class Reference

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

#include <mlXMLPersistenceStream.h>

Inheritance diagram for ml::XMLPersistenceInputStream:

Public Member Functions
	XMLPersistenceInputStream ()
	this is the default constructor, use readFromFile or readFromString to fill the DOM
	XMLPersistenceInputStream (DOMElement *container)
	this constructor will read from the given XML element
virtual	~XMLPersistenceInputStream ()
	the destructor will free the DOM document if readFromFile or readFromString was used
virtual void	readFromFile (const std::string &fileName)
	Read the complete tree from a file.
virtual void	readFromString (const std::string &str)
	Read the complete tree from a string.
Public Member Functions inherited from ml::AbstractPersistenceInputStream
virtual	~AbstractPersistenceInputStream ()
int	startStructWithVersion (const char *name=nullptr)
	Starts a struct, returns the version of struct (0 if not given).
template<typename T >
void	read (std::vector< T > &values, const char *name=nullptr)
	Reads vectors of primitive values from the stream.
template<typename T , size_t n, class DataContainer >
void	read (FloatingPointVector< T, n, DataContainer > &value, const char *name=nullptr)
	Reads float vectors like vec3f from the stream.
template<typename T , size_t n>
void	read (TVectorNDBase< T, n > &value, const char *name=nullptr)
	Reads integer vectors like ImageVector from the stream.
template<typename T , size_t n>
void	read (FloatingPointMatrix< T, n > &value, const char *name=nullptr)
	Reads float matrices like mat4 from the stream.
template<typename T >
void	readOptional (T &value, const T &defaultValue, const char *name=nullptr)
	Performs optional reading for all above methods.
virtual Base *	readObject (const char *name=nullptr)
	Reads Base object from stream.
bool	hasNextInStruct (std::string &name)
	Returns true if there is another element in the current struct scope, and if so, sets name to its name.
bool	isNextInStruct (const char *name)
	Checks whether an item with the given name comes next in the stream.
bool	hasNextListItem ()
	Checks whether there is another item in the current list.
void	versionCheck (const char *className, int objectVersion, int storedVersion)
	Prints a warning if the storedVersion is greater than the objectVersion.
virtual void	read (bool &value, const char *name=nullptr)
	Reads primitive values from the stream.
void	read (MLint32 &value, const char *name=nullptr)
void	read (MLuint32 &value, const char *name=nullptr)
void	read (MLint64 &value, const char *name=nullptr)
void	read (MLuint64 &value, const char *name=nullptr)
void	read (MLfloat &value, const char *name=nullptr)
void	read (MLdouble &value, const char *name=nullptr)
void	read (std::string &value, const char *name=nullptr)
Public Member Functions inherited from ml::AbstractPersistenceStream
void	startList (const char *name=nullptr, const char *xmlItemName="Item", bool xmlSuppressScope=false)
	Starts a new list of values in the data stream, must be ended with endList().
void	endList ()
	Ends reading/writing of the list.
void	startStruct (const char *name=nullptr)
	Starts a new struct of values in the data stream, must be ended with endStruct().
void	endStruct ()
	Ends reading/writing of struct values.

Static Public Member Functions
static void	normalizeWindowsFileName (std::string &str)
	replace / with \ character
bool	isBinary () const override
	overridden methods
void	readString (const char *name, std::string &value) override
	Abstract reading method that needs to be implemented by derived classes.
void	readData (std::string &value, const char *name) override
	Same as readObject for binary data (std::string misused as binary data container).
void	startListImpl (const char *name, const char *xmlItemName, bool xmlSuppressScope) override
	Abstract methods called by above methods, needs to be implemented in derived classes.
void	endListImpl () override
void	startStructImpl (const char *name) override
void	endStructImpl () override
bool	hasNextInStructImpl (std::string &name) override
	Checks whether an item with the given name comes next in the stream.
bool	hasNextListItemImpl () override
	Checks whether there is another item in the current list.
bool	getObjectID (int &id) override
	Implementation of Base object persistence, get attribute of currently open struct.
bool	getObjectType (std::string &type) override
	Returns base type.
bool	getObjectVersion (int &version) override
	Returns persistence version.
void	readValues (const char *name, size_t expected, std::vector< MLint32 > &values) override
	Abstract reading methods that need to be implemented by derived classes.
void	readValues (const char *name, size_t expected, std::vector< MLuint32 > &values) override
void	readValues (const char *name, size_t expected, std::vector< MLint64 > &values) override
void	readValues (const char *name, size_t expected, std::vector< MLuint64 > &values) override
void	readValues (const char *name, size_t expected, std::vector< MLfloat > &values) override
void	readValues (const char *name, size_t expected, std::vector< MLdouble > &values) override
void	formatError (const std::string &msg) override
	overload, improves message with current parsing location

Additional Inherited Members
Protected Member Functions inherited from ml::AbstractPersistenceInputStream
	AbstractPersistenceInputStream ()
Protected Member Functions inherited from ml::AbstractPersistenceStream
	AbstractPersistenceStream ()
virtual	~AbstractPersistenceStream ()
virtual void	nameCheck (const char *name)
	Checks whether the name is provided when being in a subgroup, or that no name is provided when being in a list.
bool	isInList () const
	Checks whether the stream is currently in 'list' mode. Otherwise, it is in 'struct' mode.
size_t	nestingDepth () const
	Returns depth of nesting stack (created by startList/startStruct), used to check nesting rules.
virtual void	internalError (const char *msg, const char *arg=nullptr)
	Logs an internal error. Usually called to indicate wrong usage of interface.

Detailed Description

Implementation for AbstractPersistenceInputStream using Xerces DOM Parser.

Definition at line 132 of file mlXMLPersistenceStream.h.

Constructor & Destructor Documentation

XMLPersistenceInputStream() [1/2]

ml::XMLPersistenceInputStream::XMLPersistenceInputStream

(

)

this is the default constructor, use readFromFile or readFromString to fill the DOM

XMLPersistenceInputStream() [2/2]

ml::XMLPersistenceInputStream::XMLPersistenceInputStream

(

DOMElement *

container

)

this constructor will read from the given XML element

~XMLPersistenceInputStream()

virtual ml::XMLPersistenceInputStream::~XMLPersistenceInputStream ( )

virtual

the destructor will free the DOM document if readFromFile or readFromString was used

Member Function Documentation

endListImpl()

void ml::XMLPersistenceInputStream::endListImpl ( )

overrideprotectedvirtual

Implements ml::AbstractPersistenceStream.

endStructImpl()

void ml::XMLPersistenceInputStream::endStructImpl ( )

overrideprotectedvirtual

Implements ml::AbstractPersistenceStream.

formatError()

void ml::XMLPersistenceInputStream::formatError ( const std::string & msg )

overrideprotectedvirtual

overload, improves message with current parsing location

Reimplemented from ml::AbstractPersistenceInputStream.

getObjectID()

bool ml::XMLPersistenceInputStream::getObjectID ( int & id )

overrideprotectedvirtual

Implementation of Base object persistence, get attribute of currently open struct.

Returns unique ID of object - currently unused.

Implements ml::AbstractPersistenceInputStream.

getObjectType()

bool ml::XMLPersistenceInputStream::getObjectType ( std::string & type )

overrideprotectedvirtual

Returns base type.

Implements ml::AbstractPersistenceInputStream.

getObjectVersion()

bool ml::XMLPersistenceInputStream::getObjectVersion ( int & version )

overrideprotectedvirtual

Returns persistence version.

Implements ml::AbstractPersistenceInputStream.

hasNextInStructImpl()

bool ml::XMLPersistenceInputStream::hasNextInStructImpl ( std::string & name )

overrideprotectedvirtual

Checks whether an item with the given name comes next in the stream.

The stream is guaranteed to be in a 'struct' scope.

Implements ml::AbstractPersistenceInputStream.

hasNextListItemImpl()

bool ml::XMLPersistenceInputStream::hasNextListItemImpl ( )

overrideprotectedvirtual

Checks whether there is another item in the current list.

The stream is guaranteed to be in a 'list' scope.

Implements ml::AbstractPersistenceInputStream.

isBinary()

bool ml::XMLPersistenceInputStream::isBinary ( ) const

inlineoverridevirtual

overridden methods

Implements ml::AbstractPersistenceStream.

Definition at line 155 of file mlXMLPersistenceStream.h.

normalizeWindowsFileName()

static void ml::XMLPersistenceInputStream::normalizeWindowsFileName ( std::string & str )

static

replace / with \ character

readData()

void ml::XMLPersistenceInputStream::readData ( std::string & value, const char * name )

overridevirtual

Same as readObject for binary data (std::string misused as binary data container).

Implements ml::AbstractPersistenceInputStream.

readFromFile()

virtual void ml::XMLPersistenceInputStream::readFromFile ( const std::string & fileName )

virtual

Read the complete tree from a file.

readFromString()

virtual void ml::XMLPersistenceInputStream::readFromString ( const std::string & str )

virtual

Read the complete tree from a string.

readString()

void ml::XMLPersistenceInputStream::readString ( const char * name, std::string & value )

overridevirtual

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

Implements ml::AbstractPersistenceInputStream.

readValues() [1/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLdouble > & values )

overrideprotectedvirtual

Implements ml::AbstractPersistenceInputStream.

readValues() [2/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLfloat > & values )

overrideprotectedvirtual

Implements ml::AbstractPersistenceInputStream.

readValues() [3/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLint32 > & values )

overrideprotectedvirtual

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

If expected size is 0, the returned list may have any size, otherwise exactly that number of elements are returned (or an exception is thrown).

Implements ml::AbstractPersistenceInputStream.

readValues() [4/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLint64 > & values )

overrideprotectedvirtual

Implements ml::AbstractPersistenceInputStream.

readValues() [5/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLuint32 > & values )

overrideprotectedvirtual

Implements ml::AbstractPersistenceInputStream.

readValues() [6/6]

void ml::XMLPersistenceInputStream::readValues ( const char * name, size_t expected, std::vector< MLuint64 > & values )

overrideprotectedvirtual

Implements ml::AbstractPersistenceInputStream.

startListImpl()

void ml::XMLPersistenceInputStream::startListImpl ( const char * name, const char * xmlItemName, bool xmlSuppressScope )

overrideprotectedvirtual

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

Implementors do not need to perform error checking.

xmlItemName and xmlSuppressScope only need to be regarded for XML format.

Implements ml::AbstractPersistenceStream.

startStructImpl()

void ml::XMLPersistenceInputStream::startStructImpl ( const char * name )

overrideprotectedvirtual

Implements ml::AbstractPersistenceStream.

---

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

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