Wrapper for enumerations to be used as a list of flags. More...

#include <flags.h>

Public Member Functions
constexpr void	reverse () noexcept
	Reverse (or logically negotiate) all bits.

constexpr void	shift_left (size_t nShift) noexcept
	Shift bits to the left. More...

constexpr void	shift_right (size_t nShift) noexcept
	Shift bits to the right. More...

constexpr	flags (enum_t eFlag) noexcept
	flags object constructor More...

template<class... args_t>
	requires (sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... >) const expr flags(args_t... flags) noexcept
	flags object constructor More...

template<class... args_t>
	requires (sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... >) const expr void add(args_t... flags) noexcept
	Add all the flags specified. More...

template<class... args_t>
	requires (sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... >) const expr void remove(args_t... flags) noexcept
	Remove all the flags specified. More...

template<class... args_t>
	requires (sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... >) const expr void xor_(args_t... flags) noexcept
	Apply a bitwise XOR to a flags value. More...

constexpr void	add (flags flags_) noexcept
	Add all the flags specified. More...

constexpr void	remove (flags flags_) noexcept
	Remove all the flags specified. More...

constexpr void	xor_ (flags flags_) noexcept
	Apply a bitwise XOR to a flags value. More...

constexpr bool	contains (enum_t eFlag) const noexcept
	Check if flag is present. More...

template<class... args_t>
	requires (sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... >) const expr bool contains_all(args_t... flags) const noexcept
	Check if all the specified flags are present. More...

constexpr bool	contains_all (flags other) const noexcept
	Check if all the specified flags are present. More...

template<class... args_t>
	requires (sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... >) const expr bool contains_any(args_t... flags) const noexcept
	Check if any of the specified flags is present. More...

constexpr bool	contains_any (flags other) const noexcept
	Check if any of the specified flags is present. More...

constexpr underlying_type	to_integer () const noexcept
	Convert to the corresponding integer value. More...

Static Public Member Functions
static constexpr flags	all_flags () noexcept
	Get a flags with all bits equal 1. More...

Detailed Description

template<enumeration_c enum_t>
class qx::flags< enum_t >

Wrapper for enumerations to be used as a list of flags.

Template Parameters

enum_t

- enum flags type

enum class EFlags
{
    None   = 0,
    First  = 1 << 0,
    Second = 1 << 1,
    Third  = 1 << 2,
    Fourth = 1 << 3,
};
 
qx::flags<EFlags> flags;

Definition at line 61 of file flags.h.

Constructor & Destructor Documentation

◆ flags()

template<enumeration_c enum_t>

constexpr qx::flags< enum_t >::flags ( enum_t eFlag )

constexprnoexcept

flags object constructor

Separate method for 1 arg to allow type deduction

Parameters

eFlag - flag to add at construction

Definition at line 70 of file flags.inl.

Member Function Documentation

◆ add()

template<enumeration_c enum_t>

constexpr void qx::flags< enum_t >::add ( flags< enum_t > flags_ )

constexprnoexcept

Add all the flags specified.

Parameters

flags_ - flags to add

◆ all_flags()

template<enumeration_c enum_t>

static constexpr flags qx::flags< enum_t >::all_flags ( )

staticconstexprnoexcept

Get a flags with all bits equal 1.

Return values

-	flags with all bits equal 1

◆ contains()

template<enumeration_c enum_t>

constexpr bool qx::flags< enum_t >::contains ( enum_t eFlag ) const

constexprnoexcept

Check if flag is present.

Parameters

eFlag - flag to check

Return values

-	true if flag is present

◆ contains_all()

template<enumeration_c enum_t>

constexpr bool qx::flags< enum_t >::contains_all ( flags< enum_t > other ) const

constexprnoexcept

Check if all the specified flags are present.

Parameters

other - flags to check

Return values

-	true if all the specified flags are present

◆ contains_any()

template<enumeration_c enum_t>

constexpr bool qx::flags< enum_t >::contains_any ( flags< enum_t > other ) const

constexprnoexcept

Check if any of the specified flags is present.

Parameters

other - flags to check

Return values

-	true if any of the specified flags is present

◆ remove()

template<enumeration_c enum_t>

constexpr void qx::flags< enum_t >::remove ( flags< enum_t > flags_ )

constexprnoexcept

Remove all the flags specified.

Parameters

flags_ - flags to remove

◆ requires() [1/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

Add all the flags specified.

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to add

◆ requires() [2/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

Remove all the flags specified.

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to remove

◆ requires() [3/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=1 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

Apply a bitwise XOR to a flags value.

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to apply

◆ requires() [4/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

Check if all the specified flags are present.

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to check

Return values

true	if all the specified flags are present

◆ requires() [5/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

Check if any of the specified flags is present.

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to check

Return values

-	true if any of the specified flags is present

◆ requires() [6/6]

template<enumeration_c enum_t>

template<class... args_t>

qx::flags< enum_t >::requires ( sizeof...(args_t) >=2 &&specific_variadic_args_v< enum_t, args_t... > ) const

noexcept

flags object constructor

Template Parameters

args_t... - template parameters pack, all types should be same as enum_t

Parameters

flags - flags to add at construction

◆ shift_left()

template<enumeration_c enum_t>

constexpr void qx::flags< enum_t >::shift_left ( size_t nShift )

constexprnoexcept

Shift bits to the left.

Parameters

nShift - num of positions to shift

Definition at line 20 of file flags.inl.

◆ shift_right()

template<enumeration_c enum_t>

constexpr void qx::flags< enum_t >::shift_right ( size_t nShift )

constexprnoexcept

Shift bits to the right.

Parameters

nShift - num of positions to shift

Definition at line 26 of file flags.inl.

◆ to_integer()

template<enumeration_c enum_t>

constexpr underlying_type qx::flags< enum_t >::to_integer ( ) const

constexprnoexcept

Convert to the corresponding integer value.

Return values

-	integer value

◆ xor_()

template<enumeration_c enum_t>

constexpr void qx::flags< enum_t >::xor_ ( flags< enum_t > flags_ )

constexprnoexcept

Apply a bitwise XOR to a flags value.

Parameters

flags_ - flags to apply

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

include/qx/containers/flags.h
include/qx/containers/flags.inl

Public Member Functions

Static Public Member Functions

Detailed Description

template<enumeration_c enum_t> class qx::flags< enum_t >

Constructor & Destructor Documentation

◆ flags()

Member Function Documentation

◆ add()

◆ all_flags()

◆ contains()

◆ contains_all()

◆ contains_any()

◆ remove()

◆ requires() [1/6]

◆ requires() [2/6]

◆ requires() [3/6]

◆ requires() [4/6]

◆ requires() [5/6]

◆ requires() [6/6]

◆ shift_left()

◆ shift_right()

◆ to_integer()

◆ xor_()

template<enumeration_c enum_t>
class qx::flags< enum_t >