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

#include <UN_Types.h>

+ Inheritance diagram for UN_PortIndex:

Public Member Functions

 UN_PortIndex (UN_DataIndex data_index=UN_DataIndex())
 
- 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_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

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

Definition at line 234 of file UN_Types.h.

Constructor & Destructor Documentation

UN_PortIndex::UN_PortIndex ( UN_DataIndex  data_index = UN_DataIndex())
inlineexplicit

Definition at line 237 of file UN_Types.h.


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