Struct INodeCollection#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct INodeCollection#

Interface allowing access to table and array nodes.

Subclassed by CNodeCollection

Public Functions

virtual uint32_t GetCount() const = 0#

Returns the amount of nodes.

Returns:

The amount of nodes.

virtual IInterfaceAccess *GetNode(uint32_t uiIndex) const = 0#

Get the node.

Parameters:

uiIndex[in] Index of the node to get.

Returns:

Interface to the node object.

virtual IInterfaceAccess *GetNodeDirect(const sdv::u8string &ssPath) const = 0#

Searches a node by its key in the parse tree.

Elements of tables can be accessed and traversed by using ‘.’ to separated the parent name from child name. E.g. ‘parent.child’ would access the ‘child’ element of the ‘parent’ table. Elements of arrays can be accessed and traversed by using the index number in brackets. E.g. ‘array[3]’ would access the fourth element of the array ‘array’. These access conventions can also be chained like ‘table.array[2][1].subtable.integerElement’.

Attention

Array indexing starts with 0!

Parameters:

ssPath[in] The path of the Node to searched for.

Returns:

Returns an interface the requested node if available.

uint32 GetCount() const

Returns the amount of nodes.

Returns:

The amount of nodes.

IInterfaceAccess GetNode (in uint32 uiIndex) const

Get the node.

Parameters:

uiIndex[in] Index of the node to get.

Returns:

Interface to the node object.

IInterfaceAccess GetNodeDirect (in u8string ssPath) const

Searches a node by its key in the parse tree.

Elements of tables can be accessed and traversed by using ‘.’ to separated the parent name from child name. E.g. ‘parent.child’ would access the ‘child’ element of the ‘parent’ table. Elements of arrays can be accessed and traversed by using the index number in brackets. E.g. ‘array[3]’ would access the fourth element of the array ‘array’. These access conventions can also be chained like ‘table.array[2][1].subtable.integerElement’.

Attention

Array indexing starts with 0!

Parameters:

ssPath[in] The path of the Node to searched for.

Returns:

Returns an interface the requested node if available.

Public Static Attributes

static ::sdv::interface_id _id = 0xBC836E7F94697937#

Interface ID.