Detailed Description

Inheritance diagram for XmlNode:

Public Member Methods
const StaticString< XmlNodeNameMaxLength > &	GetName () const
	Node name. More...

const StaticString< XmlNodeNameMaxLength > &	GetName ()
	Node name. More...

void	SetName (const StaticString< XmlNodeNameMaxLength > &value)
	Node name. More...

	XmlNode (PCChar8 name)
	Constructor. More...

virtual XmlNode *	GetNode (PCChar8 name, bool createIfNotExist=false)
	Gets a node. More...

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

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

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

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

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

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

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

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

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

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

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

Stream &	GetReadNodeStream (bool resetReading=true)
	Gets the node's stream. More...

Stream &	GetWriteNodeStream (bool createIfNotExist=true, bool resetWriting=true)
	Gets the node's stream. More...

virtual void	WriteValue (PCChar8 valueName, PCChar8 value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, const IStringConvertible &value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, Int32 value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, UInt32 value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, Int64 value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, UInt64 value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, bool value)
	Writes a value. More...

virtual void	WriteValue (PCChar8 valueName, Float64 value)
	Writes a value. More...

virtual void	Clear ()
	Clear the node. More...

virtual bool	HasContent ()
	Query if the node has a content. More...

void	ReadFrom (XmlReader &reader)
	Reads from. More...

void	WriteTo (XmlWriter &writer)
	Write to. More...

Private fields
StaticString< XmlNodeNameMaxLength >	Name
	Node name. More...

Constructor & Destructor Documentation

XmlNode ( PCChar8 name )

Constructor.

Parameters

name	[in] Node name.

Methods Documentation

virtual void Clear ( )

virtual

Clear the node.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

Reimplemented in XmlDocumentSymmetricSigned.

const StaticString< XmlNodeNameMaxLength > & GetName ( )

inline

Node name.

See also: Field: Name

Returns: the property value

See also: Setter: SetName()

const StaticString< XmlNodeNameMaxLength > & GetName ( ) const

inline

Node name.

See also: Field: Name

Returns: the property value

See also: Setter: SetName()

virtual XmlNode* GetNode	(	PCChar8	name,
		bool	createIfNotExist = `false`
	)

virtual

Gets a node.

Parameters

name	[in] Node name.
createIfNotExist	[in] (Optional) Creates the node if this not exists. Default = false.

Returns: The found node. NULL if not found.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

Stream& GetReadNodeStream ( bool resetReading = true )

Gets the node's stream.

Parameters

resetReading [in] (Optional) Reset the stream for reading. Default = true

Returns: The stream for reading.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_TRY_TO_ACCESS_UNEXISTANT_CONTENT

Stream& GetWriteNodeStream	(	bool	createIfNotExist = `true`,
		bool	resetWriting = `true`
	)

Gets the node's stream.

Parameters

createIfNotExist	[in] (Optional) Creates the node if this not exists. Default = true.
resetWriting	[in] (Optional) Reset the stream for writing. Default = true.

Returns: The stream for writing.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_TRY_TO_ACCESS_UNEXISTANT_CONTENT

virtual bool HasContent ( )

virtual

Query if the node has a content.

Returns: True if there is, false if not.

There is no content when the node value or subnode are not affected. In case of content loaded from a file, the content is undefined when the read XML tags are empty.

void ReadFrom ( XmlReader & reader )

Reads from.

Parameters

reader [in,out] The xml reader.

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

virtual bool 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.

Returns: True if value has been found, false if default value has been used.

RT Exceptions:: RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

void SetName ( const StaticString< XmlNodeNameMaxLength > & value )

inline

Node name.

Parameters

[in] value The new parameter value.

Returns: the property value

See also: Field: Name; Getter: GetName()

void WriteTo ( XmlWriter & writer )

Write to.

Parameters

writer [in,out] The xml writer.

virtual void WriteValue	(	PCChar8	valueName,
		PCChar8	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		const IStringConvertible &	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		Int32	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		UInt32	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		Int64	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		UInt64	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		bool	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

virtual void WriteValue	(	PCChar8	valueName,
		Float64	value
	)

virtual

Writes a value.

Parameters

valueName	The valueName.
value	The value.

Warning: Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

RT Exceptions:

RT_ERROR_XML_NODE_CONTENT_TYPE_MISSMATCH

RT_ERROR_INTERNAL_UNEXPECTED_NULL_POINTER

Fields Documentation

StaticString< XmlNodeNameMaxLength > Name

private

Node name.

See also: Getter: GetName(); Setter: SetName()

Detailed Description

Public Member Methods

Private fields

Constructor & Destructor Documentation

Methods Documentation

Fields Documentation