UN_DataIndex Class Reference

#include <UN_Types.h>

Inheritance diagram for UN_DataIndex:

Public Member Functions
	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...

Additional Inherited Members
Public Types inherited from UN_DataNumber
enum	ValueType : ValueIntType
using	ValueIntType = exint
Static Public Attributes inherited from UN_DataNumber
static constexpr ValueType	INVALID_NUMBER = ValueType(-1)

Detailed Description

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

Definition at line 143 of file UN_Types.h.

Constructor & Destructor Documentation

UN_DataIndex::UN_DataIndex ( ValueType  value = INVALID_NUMBER )

inlineexplicit

Definition at line 146 of file UN_Types.h.

UN_DataIndex::UN_DataIndex ( UN_DataSize  size )

inlineexplicit

For past-end array index.

Definition at line 150 of file UN_Types.h.

UN_DataIndex::UN_DataIndex ( exint  value )

inlineexplicit

An exint is used for indexing into UT_Array, and UN_DataIndex represents such index, so these types should be interchangeable. Thus providing a constructor from exint.

Definition at line 156 of file UN_Types.h.

Member Function Documentation

void UN_DataIndex::clear ( void  )

inline

Resets the index to an invalid value.

Definition at line 161 of file UN_Types.h.

exint UN_DataIndex::exintValue ( ) const

inline

Returns an exint value of this data index.

Definition at line 165 of file UN_Types.h.

UN_DataIndex::operator exint ( ) const

inline

Implicit cast to exint for indexing into arrays (eg, UT_Array).

Definition at line 172 of file UN_Types.h.

---

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

• UN/UN_Types.h