Some utilities on enumeration types. More...

Classes
struct	ts::EnableBitMaskOperators< T >
	This traits is used to enable bitmask operators on an enumeration type. More...

struct	ts::underlying_type< T >
	The meta-type ts::underlying_type is a generalization of std::underlying_type which works on integer types as well. More...

Namespaces
namespace	ts
	TSDuck namespace, containing all TSDuck classes and functions.

Macros
#define	TS_ENABLE_BITMASK_OPERATORS(T)
	This macro enables bitmask operators on an enumeration type.

Functions
template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value constexpr bool	operator! (ENUM a)
	Boolean "not" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value constexpr ENUM	operator& (ENUM a, ENUM b)
	Bitmask "and" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value ENUM &	operator&= (ENUM &a, ENUM b)
	Bitmask "assign and" operator on enumeration types.

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>
constexpr ENUM	operator<< (ENUM a, size_t b)
	Bitmask "left shift" operator on enumeration types.

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>
ENUM &	operator<<= (ENUM &a, size_t b)
	Bitmask "assign left shift" operator on enumeration types.

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>
constexpr ENUM	operator>> (ENUM a, size_t b)
	Bitmask "right shift" operator on enumeration types.

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>
ENUM &	operator>>= (ENUM &a, size_t b)
	Bitmask "assign right shift" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value constexpr ENUM	operator^ (ENUM a, ENUM b)
	Bitmask "xor" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value ENUM &	operator^= (ENUM &a, ENUM b)
	Bitmask "assign xor" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value constexpr ENUM	operator\| (ENUM a, ENUM b)
	Bitmask "or" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value ENUM &	operator\|= (ENUM &a, ENUM b)
	Bitmask "assign or" operator on enumeration types.

template<typename ENUM > requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>
::value constexpr ENUM	operator~ (ENUM a)
	Bitmask "not" unary operator on enumeration types.

Detailed Description

Some utilities on enumeration types.

Macro Definition Documentation

◆ TS_ENABLE_BITMASK_OPERATORS

#define TS_ENABLE_BITMASK_OPERATORS ( T )

This macro enables bitmask operators on an enumeration type.

Parameters

T	An enumeration type or enumeration class.

Example:

enum E {A = 0x01, B = 0x02, C = 0x04};
TS_ENABLE_BITMASK_OPERATORS(E);
 
E e = A | B | C;
e ^= B | C;

Function Documentation

◆ operator~()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value constexpr ENUM operator~ ( ENUM a )

inlineconstexpr

Bitmask "not" unary operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in] a Operand.

Returns: Bitwise "not" a

◆ operator!()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value constexpr bool operator! ( ENUM a )

inlineconstexpr

Boolean "not" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in] a Enumeration value. Typically an expression uing bitmask "and" or "or" operators on ENUM.

Returns: True if a is zero (no flag set).

◆ operator|()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value constexpr ENUM operator\|	(	ENUM	a,
		ENUM	b
	)

inlineconstexpr

Bitmask "or" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in]	a	First operand.
[in]	b	Second operand.

Returns: Bitwise a "or" b

◆ operator&()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value constexpr ENUM operator&	(	ENUM	a,
		ENUM	b
	)

inlineconstexpr

Bitmask "and" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in]	a	First operand.
[in]	b	Second operand.

Returns: Bitwise a "and" b

◆ operator^()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value constexpr ENUM operator^	(	ENUM	a,
		ENUM	b
	)

inlineconstexpr

Bitmask "xor" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in]	a	First operand.
[in]	b	Second operand.

Returns: Bitwise a "xor" b

◆ operator|=()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value ENUM & operator\|=	(	ENUM &	a,
		ENUM	b
	)

inline

Bitmask "assign or" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in,out]	a	Variable to update.
[in]	b	Second operand.

Returns: A reference to a.

◆ operator&=()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value ENUM & operator&=	(	ENUM &	a,
		ENUM	b
	)

inline

Bitmask "assign and" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in,out]	a	Variable to update.
[in]	b	Second operand.

Returns: A reference to a.

◆ operator^=()

template<typename ENUM >
requires std::is_enum_v<ENUM> && ts::EnableBitMaskOperators<ENUM>

::value ENUM & operator^=	(	ENUM &	a,
		ENUM	b
	)

inline

Bitmask "assign xor" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in,out]	a	Variable to update.
[in]	b	Second operand.

Returns: A reference to a.

◆ operator<<()

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>

constexpr ENUM operator<<	(	ENUM	a,
		size_t	b
	)

inlineconstexpr

Bitmask "left shift" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in]	a	Enum value to shift.
[in]	b	Number of bits to shift.

Returns: Bitwise a, shifted left b bits.

Implementation note: The use of std::enable_if instead of the "requires" directive is a workaround for a bug in clang 19.

◆ operator>>()

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>

constexpr ENUM operator>>	(	ENUM	a,
		size_t	b
	)

inlineconstexpr

Bitmask "right shift" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in]	a	Enum value to shift.
[in]	b	Number of bits to shift.

Returns: Bitwise a, shifted right b bits.

Implementation note: The use of std::enable_if instead of the "requires" directive is a workaround for a bug in clang 19.

◆ operator<<=()

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>

ENUM & operator<<=	(	ENUM &	a,
		size_t	b
	)

inline

Bitmask "assign left shift" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in,out]	a	Enum variable to shift.
[in]	b	Number of bits to shift.

Returns: A reference to a.

Implementation note: The use of std::enable_if instead of the "requires" directive is a workaround for a bug in clang 19.

◆ operator>>=()

template<typename ENUM , typename std::enable_if< std::is_enum< ENUM >::value &&ts::EnableBitMaskOperators< ENUM >::value >::type * = nullptr>

ENUM & operator>>=	(	ENUM &	a,
		size_t	b
	)

inline

Bitmask "assign right shift" operator on enumeration types.

Template Parameters

ENUM	An enumeration type or enumeration class.

Parameters

[in,out]	a	Enum variable to shift.
[in]	b	Number of bits to shift.

Returns: A reference to a.

Implementation note: The use of std::enable_if instead of the "requires" directive is a workaround for a bug in clang 19.

Classes

Namespaces

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ TS_ENABLE_BITMASK_OPERATORS

Function Documentation

◆ operator~()

◆ operator!()

◆ operator|()

◆ operator&()

◆ operator^()

◆ operator|=()

◆ operator&=()

◆ operator^=()

◆ operator<<()

◆ operator>>()

◆ operator<<=()

◆ operator>>=()