Class CNodeIndex#

Nested Relationships#

Nested Types#

Class Documentation#

class CNodeIndex#

Node index object used to manage the node order.

Public Functions

virtual ~CNodeIndex()#

Destructor.

CNodeIndex(const CNodeIndex &rIndex)#

Copy constructor of the node index object.

Parameters:

rIndex[in] Reference to the index object to copy from.

CNodeIndex(CNodeIndex &&rIndex)#

Move constructor of the node index object.

Parameters:

rIndex[in] Reference to the index object to move from.

CNodeIndex &operator=(const CNodeIndex &rIndex)#

Copy assignment operator of the node index object.

Parameters:

rIndex[in] Reference to the index object to copy from.

Returns:

Returns a reference to this object.

CNodeIndex &operator=(CNodeIndex &&rIndex)#

Move assignment operator of the node index object.

Parameters:

rIndex[in] Reference to the index object to move from.

Returns:

Returns a reference to this object.

bool operator==(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is identical to the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is identical to this index.

bool operator!=(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is not identical to the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is different than this index.

bool operator<(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is smaller than the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is smaller than this index.

bool operator<=(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is smaller than or equal to the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is smaller than or equal to this index.

bool operator>(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is larger than the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is larger than this index.

bool operator>=(const CNodeIndex &rIndex) const#

Compare this node index object to the supplied index object and return whether the position of this object is larger than or equal to the position of the supplied object.

Parameters:

rIndex[in] Reference to the node index object to compare with.

Returns:

Returns whether the provided index is larger than or equal to this index.

operator bool() const#

Check for validity.

Returns:

Returns whether the index object contains a valid index.

void MoveBefore(const CNodeIndex &rIndex)#

Move the node index object before the index object provided as an argument.

Parameters:

rIndex[in] Reference to the node index object to move the object before.

uint32_t Index() const#

Get the index in the list. Returns sdv::toml::npos if the index is not in the list any more.

Remark

This index os calculated dynamically and can change if indices are added, removed or swapped.

Returns:

The current index in the list.