ABitField< T > Class Template Reference

Bit field implementation.

#include <AUI/Util/ABitField.h>

Public Member Functions#
	ABitField (T storage=static_cast< T >(0))
	operator T ()
T &	value ()
const T &	value () const
ABitField &	operator<< (T flag)
	Sets flag.
ABitField &	operator>> (T flag)
	Resets flag.
bool	checkAndSet (T flag)
	Determines whether flag set or not and resets flag.
bool	checkAndReset (T flag)
	Determines whether flag set or not and sets flag.
bool	test (T flags) const
	Determines whether flag (or all flags) set or not.
bool	testAny (T flags) const
	Determines whether flag (or one of the flags flags) set or not.
bool	operator& (T flags) const
	Determines whether flag(s) set or not.
void	set (T flag, bool value)

Member Function Documentation#

checkAndReset()#

template<typename T = uint32_t>

bool ABitField< T >::checkAndReset ( T flag )

inline

Parameters

flag

flag

Returns

true if flag was reset

checkAndSet()#

template<typename T = uint32_t>

bool ABitField< T >::checkAndSet ( T flag )

inline

Parameters

flag

flag

Returns

true if flag was set

operator&()#

template<typename T = uint32_t>

bool ABitField< T >::operator& ( T flags ) const

inline

Parameters

flags

flag(s)

Returns

true if flag(s) set

Note

This function supports multiple flags (i.e check(FLAG1 | FLAG2)).

operator<<()#

template<typename T = uint32_t>

ABitField & ABitField< T >::operator<< ( T flag )

inline

Parameters

flag

flag

Returns

this

operator>>()#

template<typename T = uint32_t>

ABitField & ABitField< T >::operator>> ( T flag )

inline

Parameters

flag

flag

Returns

this

test()#

template<typename T = uint32_t>

bool ABitField< T >::test ( T flags ) const

inline

Parameters

flags

flag(s)

Returns

true if flag(s) set

Note

This function supports multiple flags (i.e check(FLAG1 | FLAG2)).

testAny()#

template<typename T = uint32_t>

bool ABitField< T >::testAny ( T flags ) const

inline

Parameters

flags

flag(s)

Returns

true if flag(s) set

Note

This function supports multiple flags (i.e check(FLAG1 | FLAG2)).

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

View Page SourceEdit Page Source