csFlags Class Reference
Set of flags which can be accessed through masks. More...
#include <flags.h>
Public Methods | |
csFlags (uint32 value=0) | |
Constructor. All flags are set to false by default. | |
void | SetAll (uint32 value) |
Initialize all flags to the given mask. | |
void | Set (uint32 mask) |
Set all given flags. | |
void | Reset (uint32 mask) |
Reset all given flags. | |
void | Set (uint32 mask, uint32 value) |
Set all flags with the given mask. | |
void | SetBool (uint32 mask, bool value) |
Set all flags with the given value. | |
uint32 | Get () const |
Get flags. | |
bool | Check (uint32 mask) const |
Check if any of the given flags are set. | |
bool | CheckAll (uint32 mask) const |
Check if all the given flags are set. |
Detailed Description
Set of flags which can be accessed through masks.
Definition at line 25 of file flags.h.
Constructor & Destructor Documentation
|
Constructor. All flags are set to false by default.
|
Member Function Documentation
|
Check if any of the given flags are set.
|
|
Check if all the given flags are set.
|
|
Get flags.
|
|
Reset all given flags. This will clear all flags which you specify in the mask. i.e. if a mask bit is 1 then the corresponding flag will be cleared. All other flags are untouched. |
|
Set all flags with the given mask. With this function you can set and clear a series of flags but only the flags you specify in the mask will be affected. |
|
Set all given flags. This function will set all flags which are '1' in the mask. All other flags are untouched. This contrasts with SetAll() which will set all flags that are '1' in the input and clear the flags that are '0'. |
|
Initialize all flags to the given mask. You can use this function to set and clear all flags at once. If you only want to set flags (and not clear others) then use 'Set(mask)'. Definition at line 41 of file flags.h. Referenced by csPolygonMeshBox::csPolygonMeshBox(). |
|
Set all flags with the given value. This function will set all flags given in the mask with either '1' or '0' depending on the boolean input value. |
The documentation for this class was generated from the following file:
- csutil/flags.h
Generated for Crystal Space by doxygen 1.2.18