Class TBitFlagsT

class TBitFlagsT;

Description

A simple class which manages the process of setting and clearing flags in an abstract fashion.

Members

Defined in TBitFlagsT:

• Assign(TInt,TBool)Set or clear a particular flag
• Clear(TInt)Clear a particular flag
• ClearAll()Clear all the flags
• IsClear(TInt)constCheck if a particular flag is clear
• IsSet(TInt)constCheck if a particular flag is set
• Set(TInt)Set a particular flag
• SetAll()Set all the flags
• SetValue(T)Assign a new value (directly) to this flag object. Replaces any existing individ...
• TBitFlagsT()Default constructor - initialize all flags to zero
• TBitFlagsT(T)Initialize the whole flag to a certain value
• TBitFlagsT(const TBitFlagsT &)Copy constructor - initialize this flag object to mirror that of aFlags.
• Toggle(TInt)Change the state of a particular flag. If the flag at the specified index was cl...
• Value()constAccess the underlying value of the flag.
• iFlags
• operator=(const TBitFlagsT &)Assignment operator - assign specific value to the whole flag, replacing any exi...
• operator==(const TBitFlagsT &)Compare the value of the whole flag with a given value.
• operator[](TInt)constCheck if a particular flag is set or not

inline TBitFlagsT();

Description

Default constructor - initialize all flags to zero

inline TBitFlagsT(T aFlags);

Description

Initialize the whole flag to a certain value

Parameters

inline TBitFlagsT(const TBitFlagsT &aFlags);

Description

Copy constructor - initialize this flag object to mirror that of aFlags.

Parameters

inline void SetAll();

Description

Set all the flags

inline void ClearAll();

Description

Clear all the flags

inline void Set(TInt aFlagIndex);

Description

Set a particular flag

Parameters

inline void Clear(TInt aFlagIndex);

Description

Clear a particular flag

Parameters

inline void Assign(TInt aFlagIndex, TBool aValue);

Description

Set or clear a particular flag

If aValue is 1, then the flag is set If aValue is 0, then the flag is cleared

Parameters

inline void Toggle(TInt aFlagIndex);

Description

Change the state of a particular flag. If the flag at the specified index was clear, then it becomes set, otherwise it becomes clear.

Parameters

inline TBool operator[](TInt aFlagIndex) const;

Description

Check if a particular flag is set or not

Parameters

Return value

inline TBitFlagsT& operator=(const TBitFlagsT &aFlags);

Description

Assignment operator - assign specific value to the whole flag, replacing any existing value.

Parameters

Return value

inline TBool operator==(const TBitFlagsT &aFlags);

Description

Compare the value of the whole flag with a given value.

Parameters

Return value

inline TBool IsSet(TInt aFlagIndex) const;

Description

Check if a particular flag is set

Parameters

Return value

inline TBool IsClear(TInt aFlagIndex) const;

Description

Check if a particular flag is clear

Parameters

Return value

inline T Value() const;

Description

Access the underlying value of the flag.

Return value

inline void SetValue(T aFlags);

Description

Assign a new value (directly) to this flag object. Replaces any existing individual flag settings.

Parameters

T iFlags;

Description