UN_DataSize Class Reference

#include <UN_Include.h>

Inheritance diagram for UN_DataSize:

Public Member Functions
	UN_DataSize (ValueType value=ValueType(0))
	Constructs the size object given the numerical value. More...
	UN_DataSize (exint value)
	operator exint () const
	Implicit cast to exint for sizing arrays (eg, UT_Array). 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_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

A type denoting the size of data arrays indexed with UN_DataIndex. It can also be used as the size of the interval between indices, eg, to offset an index by a delta.

Definition at line 127 of file UN_Include.h.

Constructor & Destructor Documentation

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

inlineexplicit

Constructs the size object given the numerical value.

Definition at line 131 of file UN_Include.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 137 of file UN_Include.h.

Member Function Documentation

UN_DataSize::operator exint ( ) const

inline

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

Definition at line 142 of file UN_Include.h.

---

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

• UN/UN_Include.h