TBitFlagsT Class Reference
A simple class which manages the process of setting and clearing flags in an abstract fashion.
Constructor & Destructor Documentation
TBitFlagsT()
Default constructor - initialize all flags to zero
TBitFlagsT(T)
|
TBitFlagsT
|
(
|
T
|
aFlags
|
)
|
[inline]
|
Initialize the whole flag to a certain value
TBitFlagsT(const TBitFlagsT &)
Copy constructor - initialize this flag object to mirror that of aFlags.
Member Functions Documentation
Assign(TInt, TBool)
|
void
|
Assign
|
(
|
TInt
|
aFlagIndex,
|
|
|
TBool
|
aValue
|
|
|
)
|
[inline]
|
Set or clear a particular flag
If aValue is 1, then the flag is set If aValue is 0, then the flag is cleared
Clear(TInt)
|
void
|
Clear
|
(
|
TInt
|
aFlagIndex
|
)
|
[inline]
|
ClearAll()
|
void
|
ClearAll
|
(
|
)
|
[inline]
|
FlagMask(TInt)
|
T
|
FlagMask
|
(
|
TInt
|
aFlagIndex
|
)
|
const [private, inline]
|
Generate a mask for a particular flag
IsClear(TInt)
|
TBool
|
IsClear
|
(
|
TInt
|
aFlagIndex
|
)
|
const [inline]
|
Check if a particular flag is clear
IsSet(TInt)
|
TBool
|
IsSet
|
(
|
TInt
|
aFlagIndex
|
)
|
const [inline]
|
Check if a particular flag is set
Set(TInt)
|
void
|
Set
|
(
|
TInt
|
aFlagIndex
|
)
|
[inline]
|
SetValue(T)
|
void
|
SetValue
|
(
|
T
|
aFlags
|
)
|
[inline]
|
Assign a new value (directly) to this flag object. Replaces any existing individual flag settings.
Toggle(TInt)
|
void
|
Toggle
|
(
|
TInt
|
aFlagIndex
|
)
|
[inline]
|
Change the state of a particular flag. If the flag at the specified index was clear, then it becomes set, otherwise it becomes clear.
Value()
|
T
|
Value
|
(
|
)
|
const [inline]
|
Access the underlying value of the flag.
operator=(const TBitFlagsT &)
Assignment operator - assign specific value to the whole flag, replacing any existing value.
operator==(const TBitFlagsT &)
Compare the value of the whole flag with a given value.
operator[](TInt)
|
TBool
|
operator[]
|
(
|
TInt
|
aFlagIndex
|
)
|
const [inline]
|
Check if a particular flag is set or not
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.