IoXmlNodeInterface Class Reference

#include <ioxmlparser.h>

Detailed Description

XML node/property object.

Public Member Functions
const MAXON_METHOD IoXmlNodeInterface *	GetPrev () const
const MAXON_METHOD IoXmlNodeInterface *	GetNext () const
const MAXON_METHOD IoXmlNodeInterface *	GetUp () const
const MAXON_METHOD IoXmlNodeInterface *	GetDown () const
MAXON_METHOD IoXmlNodeInterface *	GetPrev ()
MAXON_METHOD IoXmlNodeInterface *	GetNext ()
MAXON_METHOD IoXmlNodeInterface *	GetUp ()
MAXON_METHOD IoXmlNodeInterface *	GetDown ()
const MAXON_METHOD String &	GetName () const
const MAXON_METHOD String &	GetValue () const
const MAXON_METHOD String &	GetAttributes () const
MAXON_METHOD Result< void >	GetInt (Int32 &val) const
MAXON_METHOD Result< void >	GetUInt (UInt32 &val) const
MAXON_METHOD Result< void >	GetInt (Int64 &val) const
MAXON_METHOD Result< void >	GetUInt (UInt64 &val) const
MAXON_METHOD Result< void >	GetFloat (Float &val) const
MAXON_METHOD IoXmlNodeInterface *	AddChild (const String &strName)
MAXON_METHOD void	Remove ()
MAXON_METHOD void	SetName (const String &strName)
MAXON_METHOD void	SetAttribute (const String &strAttribute)
MAXON_METHOD void	SetValue (const String &strValue)
MAXON_METHOD void	SetValue (const Char *strValue)

Static Public Member Functions
static MAXON_METHOD IoXmlNodeInterface *	Alloc (MAXON_SOURCE_LOCATION_DECLARATION)

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (IoXmlNodeInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.ioxmlnode")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( IoXmlNodeInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.interface.ioxmlnode"    )

private

Alloc()

static MAXON_METHOD IoXmlNodeInterface* Alloc ( MAXON_SOURCE_LOCATION_DECLARATION  )

static

GetPrev() [1/2]

const MAXON_METHOD IoXmlNodeInterface* GetPrev

(

)

const

@MAXON_ANNOTATION{refclass=false}

GetNext() [1/2]

const MAXON_METHOD IoXmlNodeInterface* GetNext

(

)

const

@MAXON_ANNOTATION{refclass=false}

GetUp() [1/2]

const MAXON_METHOD IoXmlNodeInterface* GetUp

(

)

const

@MAXON_ANNOTATION{refclass=false}

GetDown() [1/2]

const MAXON_METHOD IoXmlNodeInterface* GetDown

(

)

const

@MAXON_ANNOTATION{refclass=false}

GetPrev() [2/2]

MAXON_METHOD IoXmlNodeInterface* GetPrev

(

)

Returns the previous object.

Returns

Previous object or nullptr if non-existent.

GetNext() [2/2]

MAXON_METHOD IoXmlNodeInterface* GetNext

(

)

Returns the next object.

Returns

Next object or nullptr if non-existent.

GetUp() [2/2]

MAXON_METHOD IoXmlNodeInterface* GetUp

(

)

Returns the parent object.

Returns

Parent object or nullptr if non-existent.

GetDown() [2/2]

MAXON_METHOD IoXmlNodeInterface* GetDown

(

)

Returns the child object.

Returns

Child object or nullptr if non-existent.

GetName()

const MAXON_METHOD String& GetName

(

)

const

Returns the XML name property.

Returns

Name of this node.

GetValue()

const MAXON_METHOD String& GetValue

(

)

const

Returns the XML value property.

Returns

Value of this node.

GetAttributes()

const MAXON_METHOD String& GetAttributes

(

)

const

Returns the XML attribute property.

Returns

Attribute of this node.

GetInt() [1/2]

MAXON_METHOD Result<void> GetInt

(

Int32 &

val

)

const

Reads an XML 32-bit integer value.

Parameters

[out]

val

The variable that will be filled with the XML value.

Returns

True if the value was properly defined.

GetUInt() [1/2]

MAXON_METHOD Result<void> GetUInt

(

UInt32 &

val

)

const

Reads an XML 32-bit unsigned integer value.

Parameters

[out]

val

The variable that will be filled with the XML value.

Returns

True if the value was properly defined.

GetInt() [2/2]

MAXON_METHOD Result<void> GetInt

(

Int64 &

val

)

const

Reads an XML 64-bit integer value.

Parameters

[out]

val

The variable that will be filled with the XML value.

Returns

True if the value was properly defined.

GetUInt() [2/2]

MAXON_METHOD Result<void> GetUInt

(

UInt64 &

val

)

const

Reads an XML 64-bit unsigned integer value.

Parameters

[out]

val

The variable that will be filled with the XML value.

Returns

True if the value was properly defined.

GetFloat()

MAXON_METHOD Result<void> GetFloat

(

Float &

val

)

const

Reads an XML floating point value.

Parameters

[out]

val

The variable that will be filled with the XML value.

Returns

True if the value was properly defined.

AddChild()

MAXON_METHOD IoXmlNodeInterface* AddChild

(

const String &

strName

)

Add a child to the current node. The child will be added at the end of the child chain.

Parameters

[in]

strName

Name to set.

Returns

The new child node or nullptr in case of not enough memory.

Remove()

MAXON_METHOD void Remove

(

)

Removes a node.

SetName()

MAXON_METHOD void SetName

(

const String &

strName

)

Sets the XML name property. Keep in mind that you need to follow XML naming rules: http://www.w3schools.com/xml/xml_elements.asp.

Parameters

[in]

strName

Name to set.

SetAttribute()

MAXON_METHOD void SetAttribute

(

const String &

strAttribute

)

Sets the XML attribute property. See more here: http://www.w3schools.com/xml/xml_attributes.asp.

Parameters

[in]

strAttribute

Attribute to set.

SetValue() [1/2]

MAXON_METHOD void SetValue

(

const String &

strValue

)

Sets the XML value property.

Parameters

[in]

strValue

Value to set.

SetValue() [2/2]

MAXON_METHOD void SetValue

(

const Char *

strValue

)

Sets the XML value property.

Parameters

[in]

strValue

C-String to set.