DataStore that reads an xml formated source (Stream). More...

Detailed Description

DataStore that reads an xml formated source (Stream).

Examples:: Machine/main.cpp.

Inheritance diagram for XmlDataStoreReader:

Public Member Methods
bool	OpenReadNode (PCChar8 nodeName, IMessageCollector *messages=NULL)
	Open a node for reading. More...

void	OpenWriteNode (PCChar8 nodeName)
	Not allowed in XmlDataStoreReader. More...

void	CloseNode (PCChar8 nodeName)
	Close the opened node. More...

bool	OpenReadTextNode (PCChar8 nodeName, IMessageCollector *messages=NULL)
	Open a node for reading in text mode. More...

void	OpenWriteTextNode (PCChar8 nodeName)
	Not allowed in XmlDataStoreReader. More...

TextReaderNode &	GetTextReaderNode ()
	Get the textReaderNode after openning a node for reading in text mode. More...

TextWriterNode &	GetTextWriterNode ()
	Not allowed in XmlDataStoreReader. More...

void	CloseTextNode (PCChar8 nodeName)
	Close a text node. More...

void	ReadValue (PCChar8 valueName, BaseStaticString &value, PCChar8 defaultValue="", IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, IStringConvertible &value, const IStringConvertible defaultValue=NULL, IMessageCollector messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, bool &value, const bool &defaultValue=false, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, Int16 &value, const Int16 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, UInt16 &value, const UInt16 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, Int32 &value, const Int32 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, UInt32 &value, const UInt32 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, Int64 &value, const Int64 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, UInt64 &value, const UInt64 &defaultValue=0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, Float32 &value, const Float32 &defaultValue=0.0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, Float64 &value, const Float64 &defaultValue=0.0, IMessageCollector *messages=NULL)
	Reads a value. More...

void	ReadValue (PCChar8 valueName, ISerializable &value, IMessageCollector *messages=NULL)
	Reads a value. More...

void	WriteValue (PCChar8 valueName, PCChar8 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, const IStringConvertible &value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, Int16 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, UInt16 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, Int32 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, UInt32 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, Int64 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, UInt64 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, bool value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, Float64 value)
	Not allowed in XmlDataStoreReader. More...

void	WriteValue (PCChar8 valueName, const ISerializable &value)
	Not allowed in XmlDataStoreReader. More...

Methods Documentation

void CloseNode ( PCChar8 nodeName )

virtual

Close the opened node.

Parameters

nodeName The node name to close.

Warning: Call order dependence : Must be called after OpenReadNode() or OpenWriteNode().

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Reimplemented from XmlDataStoreStream.

void CloseTextNode ( PCChar8 nodeName )

virtual

Close a text node.

Parameters

nodeName The node name to close.

Warning: Call order dependence : Must be called after OpenReadTextNode() or OpenWriteTextNode().

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

TextReaderNode& GetTextReaderNode ( )

virtual

Get the textReaderNode after openning a node for reading in text mode.

Returns: the TextReaderNode. TextReaderNode should be disposed after usage !

Warning: Call order dependence : OpenReadTextNode() must be called before.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

TextWriterNode& GetTextWriterNode ( )

inlinevirtual

Not allowed in XmlDataStoreReader.

Returns

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

bool OpenReadNode	(	PCChar8	nodeName,
		IMessageCollector *	messages = `NULL`
	)

virtual

Open a node for reading.

Parameters

nodeName	The node name to read.
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Returns: true if it succeeds, false if it fails.

Warning: Call order dependence : Must call CloseNode() at the end of opperation.

Reimplemented from XmlDataStoreStream.

bool OpenReadTextNode	(	PCChar8	nodeName,
		IMessageCollector *	messages = `NULL`
	)

virtual

Open a node for reading in text mode.

Parameters

nodeName	The node name to read.
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Returns: true if it succeeds, false if it fails.

Warning: Call order dependence : CloseTextNode() must be called after this opening.

Implements IDataStore.

void OpenWriteNode ( PCChar8 nodeName )

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

nodeName The node name to write.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Reimplemented from XmlDataStoreStream.

void OpenWriteTextNode ( PCChar8 nodeName )

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

nodeName The node name to write.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		BaseStaticString &	value,
		PCChar8	defaultValue = `""`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = ""
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		IStringConvertible &	value,
		const IStringConvertible *	defaultValue = `NULL`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = NULL
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		bool &	value,
		const bool &	defaultValue = `false`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = false
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		Int16 &	value,
		const Int16 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		UInt16 &	value,
		const UInt16 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		Int32 &	value,
		const Int32 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		UInt32 &	value,
		const UInt32 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		Int64 &	value,
		const Int64 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		UInt64 &	value,
		const UInt64 &	defaultValue = `0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		Float32 &	value,
		const Float32 &	defaultValue = `0.0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		Float64 &	value,
		const Float64 &	defaultValue = `0.0`,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
defaultValue	(optional) The default value. Default = 0
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void ReadValue	(	PCChar8	valueName,
		ISerializable &	value,
		IMessageCollector *	messages = `NULL`
	)

virtual

Reads a value.

Parameters

valueName	The valueName name.
value	[in,out] The value.
messages	[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.

Warning: Call order dependence : OpenReadNode() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		PCChar8	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		const IStringConvertible &	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		Int16	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		UInt16	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		Int32	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		UInt32	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		Int64	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		UInt64	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		bool	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		Float64	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

void WriteValue	(	PCChar8	valueName,
		const ISerializable &	value
	)

inlinevirtual

Not allowed in XmlDataStoreReader.

Parameters

valueName	The valueName.
value	The value.

RT Exceptions:: RT_ERROR_SPECIALIZATION_NOT_SUPPORTED

Implements IDataStore.

Detailed Description

Public Member Methods

Methods Documentation