PIFlags< Enum > Class Template Reference

Container for bit flags. More...

#include <piflags.h>

Public Member Functions
	PIFlags ()
	Constructor with flags = 0.
	PIFlags (Enum e)
	Constructor with flags = Enum "e".
	PIFlags (const int i)
	Constructor with flags = int "i".
PIFlags &	setFlag (const PIFlags &f, bool on=true)
	Set flags on positions "f" to value "on".
PIFlags &	setFlag (const Enum &e, bool on=true)
	Set flag "e" to value "on".
PIFlags &	setFlag (const int &i, bool on=true)
	Set flag "i" to value "on".
void	operator= (const Enum &e)
	Assign operator.
void	operator= (const int &i)
	Assign operator.
bool	operator== (const PIFlags &f)
	Compare operator.
bool	operator== (const Enum &e)
	Compare operator.
bool	operator== (const int i)
	Compare operator.
bool	operator!= (const PIFlags &f)
	Compare operator.
bool	operator!= (const Enum &e)
	Compare operator.
bool	operator!= (const int i)
	Compare operator.
bool	operator> (const PIFlags &f)
	Compare operator.
bool	operator> (const Enum &e)
	Compare operator.
bool	operator> (const int i)
	Compare operator.
bool	operator< (const PIFlags &f)
	Compare operator.
bool	operator< (const Enum &e)
	Compare operator.
bool	operator< (const int i)
	Compare operator.
bool	operator>= (const PIFlags &f)
	Compare operator.
bool	operator>= (const Enum &e)
	Compare operator.
bool	operator>= (const int i)
	Compare operator.
bool	operator<= (const PIFlags &f)
	Compare operator.
bool	operator<= (const Enum &e)
	Compare operator.
bool	operator<= (const int i)
	Compare operator.
void	operator&= (const PIFlags &f)
	Bit-wise AND operator.
void	operator&= (const Enum &e)
	Bit-wise AND operator.
void	operator&= (const int i)
	Bit-wise AND operator.
void	operator|= (const PIFlags &f)
	Bit-wise OR operator.
void	operator|= (const Enum &e)
	Bit-wise OR operator.
void	operator|= (const int i)
	Bit-wise OR operator.
void	operator^= (const PIFlags &f)
	Bit-wise XOR operator.
void	operator^= (const Enum &e)
	Bit-wise XOR operator.
void	operator^= (const int i)
	Bit-wise XOR operator.
PIFlags	operator& (PIFlags f) const
	Bit-wise AND operator.
PIFlags	operator& (Enum e) const
	Bit-wise AND operator.
PIFlags	operator& (int i) const
	Bit-wise AND operator.
PIFlags	operator| (PIFlags f) const
	Bit-wise OR operator.
PIFlags	operator| (Enum e) const
	Bit-wise OR operator.
PIFlags	operator| (int i) const
	Bit-wise OR operator.
PIFlags	operator^ (PIFlags f) const
	Bit-wise XOR operator.
PIFlags	operator^ (Enum e) const
	Bit-wise XOR operator.
PIFlags	operator^ (int i) const
	Bit-wise XOR operator.
bool	operator[] (Enum e) const
	Test flag operator.
	operator int () const
	Implicity conversion to int.

Detailed Description

template<typename Enum>
class PIFlags< Enum >

Container for bit flags.

PIFlags is wrapper around "int". One can use it as native "int". There are manybit-wise operators, native conversion to "int" and function to test flag.
Example:

enum TestEnum {First = 0x1, Second = 0x2, Third = 0x4};
PIFlags<TestEnum> testFlags(First);
testFlags |= Third;
piCout << testFlags[First] << testFlags[Second] << testFlags[Third]; // 1 0 1
piCout << (int)testFlags; // 5