A mask of typed enums. More...

#include <mask.h>

Public Types
using	EnumType = EnumType_

using	MaskType = typename std::underlying_type< EnumType >::type

Public Member Functions
constexpr	Mask ()=default

constexpr	Mask (const Mask< EnumType > &other)=default

constexpr	Mask (Mask< EnumType > &&other)=default

constexpr	Mask (EnumType type)

constexpr	Mask (MaskType mask)

constexpr	operator MaskType () const

constexpr	operator bool () const

constexpr bool	operator< (const Mask< EnumType > &other) const

constexpr bool	operator> (const Mask< EnumType > &other) const

constexpr bool	operator>= (const Mask< EnumType > &other) const

constexpr bool	operator<= (const Mask< EnumType > &other) const

constexpr bool	operator== (const Mask< EnumType > &other) const

constexpr bool	operator!= (const Mask< EnumType > &other) const

constexpr bool	operator! () const

constexpr Mask< EnumType >	operator& (const Mask< EnumType > &other) const

constexpr Mask< EnumType >	operator\| (const Mask< EnumType > &other) const

constexpr Mask< EnumType >	operator^ (const Mask< EnumType > &other) const

constexpr Mask< EnumType >	operator~ () const

constexpr Mask< EnumType > &	operator= (const Mask< EnumType > &)=default

constexpr Mask< EnumType > &	operator= (Mask< EnumType > &&)=default

constexpr Mask< EnumType > &	operator\|= (const Mask< EnumType > &other)

constexpr Mask< EnumType > &	operator&= (const Mask< EnumType > &other)

constexpr Mask< EnumType > &	operator^= (const Mask< EnumType > &other)

Detailed Description

template<typename EnumType_>
struct impeller::Mask< EnumType_ >

A mask of typed enums.

Template Parameters

EnumType_ The type of the enum. Must be an enum class.

Definition at line 33 of file mask.h.

Member Typedef Documentation

◆ EnumType

template<typename EnumType_ >

using impeller::Mask< EnumType_ >::EnumType = EnumType_

Definition at line 34 of file mask.h.

◆ MaskType

template<typename EnumType_ >

using impeller::Mask< EnumType_ >::MaskType = typename std::underlying_type<EnumType>::type

Definition at line 35 of file mask.h.

Constructor & Destructor Documentation

◆ Mask() [1/5]

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::Mask ( )

constexprdefault

◆ Mask() [2/5]

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::Mask ( const Mask< EnumType > & other )

constexprdefault

◆ Mask() [3/5]

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::Mask ( Mask< EnumType > && other )

constexprdefault

◆ Mask() [4/5]

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::Mask ( EnumType type )

inlineconstexpr

Definition at line 43 of file mask.h.

44 : mask_(static_cast<MaskType>(type)) {}

type

uint8_t type

Definition fl_standard_message_codec_test.cc:1115

impeller::Mask::MaskType

typename std::underlying_type< EnumType >::type MaskType

Definition mask.h:35

◆ Mask() [5/5]

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::Mask ( MaskType mask )

inlineexplicitconstexpr

Definition at line 46 of file mask.h.

46: mask_(static_cast<MaskType>(mask)) {}

Member Function Documentation

◆ operator bool()

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::operator bool ( ) const

inlineexplicitconstexpr

Definition at line 52 of file mask.h.

52{ return !!mask_; }

◆ operator MaskType()

template<typename EnumType_ >

constexpr impeller::Mask< EnumType_ >::operator MaskType ( ) const

inlineexplicitconstexpr

Definition at line 50 of file mask.h.

50{ return mask_; }

◆ operator!()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator! ( ) const

inlineconstexpr

Definition at line 83 of file mask.h.

83{ return !mask_; }

◆ operator!=()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator!= ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 77 of file mask.h.

                                                               {
    return mask_ != other.mask_;
  }

◆ operator&()

template<typename EnumType_ >

constexpr Mask< EnumType > impeller::Mask< EnumType_ >::operator& ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 87 of file mask.h.

                                                                        {
    return Mask<EnumType>{mask_ & other.mask_};
  }

◆ operator&=()

template<typename EnumType_ >

constexpr Mask< EnumType > & impeller::Mask< EnumType_ >::operator&= ( const Mask< EnumType > & other )

inlineconstexpr

Definition at line 112 of file mask.h.

                                                                    {
    mask_ &= other.mask_;
    return *this;
  }

◆ operator<()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator< ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 57 of file mask.h.

                                                              {
    return mask_ < other.mask_;
  }

◆ operator<=()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator<= ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 69 of file mask.h.

                                                               {
    return mask_ <= other.mask_;
  }

◆ operator=() [1/2]

template<typename EnumType_ >

constexpr Mask< EnumType > & impeller::Mask< EnumType_ >::operator= ( const Mask< EnumType > & )

constexprdefault

◆ operator=() [2/2]

template<typename EnumType_ >

constexpr Mask< EnumType > & impeller::Mask< EnumType_ >::operator= ( Mask< EnumType > && )

constexprdefault

◆ operator==()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator== ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 73 of file mask.h.

                                                               {
    return mask_ == other.mask_;
  }

◆ operator>()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator> ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 61 of file mask.h.

                                                              {
    return mask_ > other.mask_;
  }

◆ operator>=()

template<typename EnumType_ >

constexpr bool impeller::Mask< EnumType_ >::operator>= ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 65 of file mask.h.

                                                               {
    return mask_ >= other.mask_;
  }

◆ operator^()

template<typename EnumType_ >

constexpr Mask< EnumType > impeller::Mask< EnumType_ >::operator^ ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 95 of file mask.h.

                                                                        {
    return Mask<EnumType>{mask_ ^ other.mask_};
  }

◆ operator^=()

template<typename EnumType_ >

constexpr Mask< EnumType > & impeller::Mask< EnumType_ >::operator^= ( const Mask< EnumType > & other )

inlineconstexpr

Definition at line 117 of file mask.h.

                                                                    {
    mask_ ^= other.mask_;
    return *this;
  }

◆ operator|()

template<typename EnumType_ >

constexpr Mask< EnumType > impeller::Mask< EnumType_ >::operator| ( const Mask< EnumType > & other ) const

inlineconstexpr

Definition at line 91 of file mask.h.

                                                                        {
    return Mask<EnumType>{mask_ | other.mask_};
  }

◆ operator|=()

template<typename EnumType_ >

constexpr Mask< EnumType > & impeller::Mask< EnumType_ >::operator|= ( const Mask< EnumType > & other )

inlineconstexpr

Definition at line 107 of file mask.h.

                                                                    {
    mask_ |= other.mask_;
    return *this;
  }

◆ operator~()

template<typename EnumType_ >

constexpr Mask< EnumType > impeller::Mask< EnumType_ >::operator~ ( ) const

inlineconstexpr

Definition at line 99 of file mask.h.

99{ return Mask<EnumType>{~mask_}; }

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

impeller/base/mask.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ EnumType

◆ MaskType

Constructor & Destructor Documentation

◆ Mask() [1/5]

◆ Mask() [2/5]

◆ Mask() [3/5]

◆ Mask() [4/5]

◆ Mask() [5/5]

Member Function Documentation

◆ operator bool()

◆ operator MaskType()

◆ operator!()

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator^()

◆ operator^=()

◆ operator|()

◆ operator|=()

◆ operator~()