Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
TEnumAsByte< TEnum > Class Template Reference

#include <EnumAsByte.h>

Public Types

typedef TEnum EnumType
 

Public Member Functions

FORCEINLINE TEnumAsByte ()
 
FORCEINLINE TEnumAsByte (const TEnumAsByte &InValue)
 
FORCEINLINE TEnumAsByte (TEnum InValue)
 
FORCEINLINE TEnumAsByte (int32 InValue)
 
FORCEINLINE TEnumAsByte (uint8 InValue)
 
FORCEINLINE TEnumAsByteoperator= (TEnumAsByte InValue)
 
FORCEINLINE TEnumAsByteoperator= (TEnum InValue)
 
bool operator== (TEnum InValue) const
 
bool operator== (TEnumAsByte InValue) const
 
 operator TEnum () const
 
TEnum GetValue () const
 

Private Types

typedef TEnumAsByte_EnumClass< TIsEnumClass< TEnum >::ValueCheck
 

Private Attributes

uint8 Value
 

Friends

FORCEINLINE friend uint32 GetTypeHash (const TEnumAsByte &Enum)
 

Detailed Description

template<class TEnum>
class TEnumAsByte< TEnum >

Template to store enumeration values as bytes in a type-safe way.

Definition at line 16 of file EnumAsByte.h.

Member Typedef Documentation

◆ Check

Definition at line 18 of file EnumAsByte.h.

◆ EnumType

template<class TEnum >
typedef TEnum TEnumAsByte< TEnum >::EnumType

Definition at line 21 of file EnumAsByte.h.

Constructor & Destructor Documentation

◆ TEnumAsByte() [1/5]

Default Constructor (no initialization).

Definition at line 24 of file EnumAsByte.h.

◆ TEnumAsByte() [2/5]

template<class TEnum >
FORCEINLINE TEnumAsByte< TEnum >::TEnumAsByte ( const TEnumAsByte< TEnum > & InValue)
inline

Copy constructor.

Parameters
InValuevalue to construct with.

Definition at line 31 of file EnumAsByte.h.

◆ TEnumAsByte() [3/5]

template<class TEnum >
FORCEINLINE TEnumAsByte< TEnum >::TEnumAsByte ( TEnum InValue)
inline

Constructor, initialize to the enum value.

Parameters
InValuevalue to construct with.

Definition at line 40 of file EnumAsByte.h.

+ Here is the caller graph for this function:

◆ TEnumAsByte() [4/5]

template<class TEnum >
FORCEINLINE TEnumAsByte< TEnum >::TEnumAsByte ( int32 InValue)
inlineexplicit

Constructor, initialize to the int32 value.

Parameters
InValuevalue to construct with.

Definition at line 49 of file EnumAsByte.h.

◆ TEnumAsByte() [5/5]

template<class TEnum >
FORCEINLINE TEnumAsByte< TEnum >::TEnumAsByte ( uint8 InValue)
inlineexplicit

Constructor, initialize to the int32 value.

Parameters
InValuevalue to construct with.

Definition at line 58 of file EnumAsByte.h.

Member Function Documentation

◆ GetValue()

template<class TEnum >
TEnum TEnumAsByte< TEnum >::GetValue ( ) const
inline

Gets the enumeration value.

Returns
The enumeration value.

Definition at line 122 of file EnumAsByte.h.

◆ operator TEnum()

template<class TEnum >
TEnumAsByte< TEnum >::operator TEnum ( ) const
inline

Implicit conversion to TEnum.

Definition at line 110 of file EnumAsByte.h.

◆ operator=() [1/2]

template<class TEnum >
FORCEINLINE TEnumAsByte & TEnumAsByte< TEnum >::operator= ( TEnum InValue)
inline

Assignment operator.

Parameters
InValuevalue to set.
Returns
This instance.

Definition at line 81 of file EnumAsByte.h.

◆ operator=() [2/2]

Assignment operator.

Parameters
InValuevalue to set.
Returns
This instance.

Definition at line 70 of file EnumAsByte.h.

◆ operator==() [1/2]

template<class TEnum >
bool TEnumAsByte< TEnum >::operator== ( TEnum InValue) const
inline

Compares two enumeration values for equality.

Parameters
InValueThe value to compare with.
Returns
true if the two values are equal, false otherwise.

Definition at line 93 of file EnumAsByte.h.

◆ operator==() [2/2]

template<class TEnum >
bool TEnumAsByte< TEnum >::operator== ( TEnumAsByte< TEnum > InValue) const
inline

Compares two enumeration values for equality.

Parameters
InValueThe value to compare with.
Returns
true if the two values are equal, false otherwise.

Definition at line 104 of file EnumAsByte.h.

Friends And Related Symbol Documentation

◆ GetTypeHash

template<class TEnum >
FORCEINLINE friend uint32 GetTypeHash ( const TEnumAsByte< TEnum > & Enum)
friend

Definition at line 133 of file EnumAsByte.h.

Member Data Documentation

◆ Value

template<class TEnum >
uint8 TEnumAsByte< TEnum >::Value
private

Holds the value as a byte.

Definition at line 130 of file EnumAsByte.h.


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