HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UN_DataID Class Reference

#include <UN_Include.h>

+ Inheritance diagram for UN_DataID:

Public Member Functions

constexpr UN_DataID (ValueType value=INVALID_NUMBER)
 Constructs the ID object given the numerical value. More...
 
constexpr UN_DataID (exint value)
 
 operator exint () const
 
void clear ()
 Resets the ID to an invalid value. More...
 
- Public Member Functions inherited from UN_DataNumber
constexpr UN_DataNumber (ValueType value=INVALID_NUMBER)
 
void setValue (ValueType value)
 Sets the numerical value of this number. More...
 
constexpr ValueType value () const
 Returns the numerical value of this number. More...
 
 operator ValueType () const
 
constexpr exint exintValue () const
 Returns an exint value of this number. More...
 
constexpr bool isValid () const
 Returns true if this data number is valid; false otherwise. More...
 
constexpr operator bool () const
 Returns true if this data number is valid; false otherwise. More...
 
constexpr bool operator== (const UN_DataNumber &other) const
 Comparison operators. More...
 
constexpr bool operator!= (const UN_DataNumber &other) const
 Comparison operators. More...
 
constexpr bool operator< (const UN_DataNumber &other) const
 Comparison operators. More...
 
constexpr bool operator<= (const UN_DataNumber &other) const
 Comparison operators. More...
 
constexpr bool operator> (const UN_DataNumber &other) const
 Comparison operators. More...
 
constexpr bool operator>= (const UN_DataNumber &other) const
 Comparison operators. More...
 
UN_DataNumberoperator++ ()
 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

A unique identifier of a particular data object. Data objects of the same type (eg, nodes or ports) are assigned a unique ID in a given graph, and no two data objects of that type share same ID, withing the lifespan of the given graph. Ie, unlike indices, the IDs are not reused for new data objects, even if some old objects were deleted.

Definition at line 253 of file UN_Include.h.

Constructor & Destructor Documentation

constexpr UN_DataID::UN_DataID ( ValueType  value = INVALID_NUMBER)
inlineexplicit

Constructs the ID object given the numerical value.

Definition at line 257 of file UN_Include.h.

constexpr UN_DataID::UN_DataID ( exint  value)
inlineexplicit

Definition at line 261 of file UN_Include.h.

Member Function Documentation

void UN_DataID::clear ( )
inline

Resets the ID to an invalid value.

Definition at line 271 of file UN_Include.h.

UN_DataID::operator exint ( ) const
inlineexplicit

Cast to exint for use in template functions that cast templated types, but for now make it explicit, to discourage the numerical aspect of IDs.

Definition at line 267 of file UN_Include.h.


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