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

A type denoting the size of data arrays indexed with UN_DataIndex. More...

#include <UN_Types.h>

+ Inheritance diagram for UN_DataSize:

Public Member Functions

 UN_DataSize (ValueType value=ValueType(0))
 
 UN_DataSize (exint value)
 
exint exintValue () const
 Returns an exint value of this data index. More...
 
 operator exint () const
 Implicit cast to exint for sizing 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

A type denoting the size of data arrays indexed with UN_DataIndex.

Definition at line 115 of file UN_Types.h.

Constructor & Destructor Documentation

UN_DataSize::UN_DataSize ( ValueType  value = ValueType(0))
inlineexplicit

Definition at line 118 of file UN_Types.h.

UN_DataSize::UN_DataSize ( exint  value)
inlineexplicit

An exint is used for UT_Array sizes, and UN_DataSize represents such size, so these types should be interchangeable. Thus providing a constructor from exint.

Definition at line 124 of file UN_Types.h.

Member Function Documentation

exint UN_DataSize::exintValue ( ) const
inline

Returns an exint value of this data index.

Definition at line 129 of file UN_Types.h.

UN_DataSize::operator exint ( ) const
inline

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

Definition at line 136 of file UN_Types.h.


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