#include <UN_Types.h>

Inheritance diagram for UN_NodeIndex:

Public Member Functions
	UN_NodeIndex (UN_DataIndex data_index=UN_DataIndex())
	A constructor for the node data index. More...

bool	isRootNode () const
	Returns true if this index refers to the root node. More...

Public Member Functions inherited from UN_DataIndex
	UN_DataIndex (ValueType value=INVALID_NUMBER)

	UN_DataIndex (UN_DataSize size)
	For past-end array index. More...

	UN_DataIndex (exint value)

void	clear ()
	Resets the index to an invalid value. More...

exint	exintValue () const
	Returns an exint value of this data index. More...

	operator exint () const
	Implicit cast to `exint` for indexing into arrays (eg, UT_Array). More...

Public Member Functions inherited from UN_DataNumber
	UN_DataNumber (ValueType value=INVALID_NUMBER)

void	setValue (ValueType value)
	Sets the numerical value of this number. More...

ValueType	value () const
	Returns the numerical value of this number. More...

	operator ValueType () const

bool	isValid () const
	Returns true if this data number is valid; false otherwise. More...

	operator bool () const
	Returns true if this data number is valid; false otherwise. More...

bool	operator== (const UN_DataNumber &other) const
	Comparison operators. More...

bool	operator!= (const UN_DataNumber &other) const
	Comparison operators. More...

bool	operator< (const UN_DataNumber &other) const
	Comparison operators. More...

bool	operator<= (const UN_DataNumber &other) const
	Comparison operators. More...

bool	operator> (const UN_DataNumber &other) const
	Comparison operators. More...

bool	operator>= (const UN_DataNumber &other) const
	Comparison operators. More...

UN_DataNumber &	operator++ ()
	Basic arithmetic operators. More...

UN_DataNumber	operator++ (int)
	Basic arithmetic operators. More...

Static Public Attributes
static constexpr ValueType	ROOT_NODE_INDEX = ValueType(0)

Static Public Attributes inherited from UN_DataNumber
static constexpr ValueType	INVALID_NUMBER = ValueType(-1)

Additional Inherited Members
Public Types inherited from UN_DataNumber
enum	ValueType : ValueIntType

using	ValueIntType = exint

Detailed Description

An index into a node data container, referring to a node data object. Indices may be reused for new node data objects, if old ones were deleted.

Definition at line 179 of file UN_Types.h.

Constructor & Destructor Documentation

UN_NodeIndex::UN_NodeIndex ( UN_DataIndex data_index = UN_DataIndex() )

inlineexplicit

A constructor for the node data index.

Definition at line 188 of file UN_Types.h.

Member Function Documentation

bool UN_NodeIndex::isRootNode ( ) const

inline

Returns true if this index refers to the root node.

Definition at line 192 of file UN_Types.h.

Member Data Documentation

constexpr ValueType UN_NodeIndex::ROOT_NODE_INDEX = ValueType(0)

static

An index of the graph's root node. Note, the graph root node's index value of 0 is asserted as an invariant in UN_GraphData constructor.

Definition at line 185 of file UN_Types.h.

The documentation for this class was generated from the following file:

UN/UN_Types.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation