EnumFlag< T > Class Template Reference

#include <EnumFlag.h>

Public Member Functions
constexpr	EnumFlag (T value)
constexpr EnumFlag &	operator&= (EnumFlag right)
constexpr EnumFlag &	operator|= (EnumFlag right)
constexpr EnumFlag	operator~ () const
constexpr void	RemoveFlag (EnumFlag flag)
constexpr bool	HasFlag (T flag) const
constexpr bool	HasAllFlags (T flags) const
constexpr	operator T () const
constexpr std::underlying_type_t< T >	AsUnderlyingType () const

Private Attributes
T	_value

Friends
constexpr friend EnumFlag	operator& (EnumFlag left, EnumFlag right)
constexpr friend EnumFlag	operator| (EnumFlag left, EnumFlag right)

Detailed Description

template<typename T>
class EnumFlag< T >

Definition at line 65 of file EnumFlag.h.

Constructor & Destructor Documentation

EnumFlag()

template<typename T >

constexpr EnumFlag< T >::EnumFlag ( T  value )

inlineconstexpr

Definition at line 70 of file EnumFlag.h.

 : _value(value)
 {
 }

Member Function Documentation

AsUnderlyingType()

template<typename T >

constexpr std::underlying_type_t< T > EnumFlag< T >::AsUnderlyingType ( ) const

inlineconstexpr

Definition at line 122 of file EnumFlag.h.

 {
 return static_cast<std::underlying_type_t<T>>(_value);
 }

Here is the caller graph for this function:

HasAllFlags()

template<typename T >

constexpr bool EnumFlag< T >::HasAllFlags ( T  flags ) const

inlineconstexpr

Definition at line 112 of file EnumFlag.h.

 {
 return (_value & flags) == flags;
 }

HasFlag()

template<typename T >

constexpr bool EnumFlag< T >::HasFlag ( T  flag ) const

inlineconstexpr

Definition at line 106 of file EnumFlag.h.

 {
 using i = std::underlying_type_t<T>;
 return static_cast<i>(_value & flag) != static_cast<i>(0);
 }

Here is the caller graph for this function:

operator T()

template<typename T >

constexpr EnumFlag< T >::operator T ( ) const

inlineconstexpr

Definition at line 117 of file EnumFlag.h.

 {
 return _value;
 }

operator&=()

template<typename T >

constexpr EnumFlag & EnumFlag< T >::operator&= ( EnumFlag< T >  right )

inlineconstexpr

Definition at line 74 of file EnumFlag.h.

 {
 _value &= right._value;
 return *this;
 }

operator|=()

template<typename T >

constexpr EnumFlag & EnumFlag< T >::operator|= ( EnumFlag< T >  right )

inlineconstexpr

Definition at line 85 of file EnumFlag.h.

 {
 _value |= right._value;
 return *this;
 }

operator~()

template<typename T >

constexpr EnumFlag EnumFlag< T >::operator~ ( ) const

inlineconstexpr

Definition at line 96 of file EnumFlag.h.

 {
 return static_cast<T>(~static_cast<std::underlying_type_t<T>>(_value));
 }

RemoveFlag()

template<typename T >

constexpr void EnumFlag< T >::RemoveFlag ( EnumFlag< T >  flag )

inlineconstexpr

Definition at line 101 of file EnumFlag.h.

 {
 _value &= ~flag._value;
 }

Friends And Related Function Documentation

operator&

template<typename T >

constexpr friend EnumFlag operator& ( EnumFlag< T >  left, EnumFlag< T >  right  )

friend

Definition at line 80 of file EnumFlag.h.

 {
 return left &= right;
 }

operator|

template<typename T >

constexpr friend EnumFlag operator| ( EnumFlag< T >  left, EnumFlag< T >  right  )

friend

Definition at line 91 of file EnumFlag.h.

 {
 return left |= right;
 }

Member Data Documentation

_value

template<typename T >

T EnumFlag< T >::_value

private

Definition at line 128 of file EnumFlag.h.

---

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

• src/common/Utilities/EnumFlag.h