faudes::AttributeFlags Class Reference

Boolean flags Attribute. More...

#include <cfl_attributes.h>

List of all members.

Public Member Functions

 AttributeFlags (void)
 Default constructor.
 AttributeFlags (const AttributeFlags &rOther)
 Copy constructor.
virtual ~AttributeFlags (void)
 Destructor.
bool Test (fType mask) const
 Test a flag.
bool TestAll (fType mask) const
 Test multible flags, combine by "and".
bool TestSome (fType mask) const
 Test multible flags, combine by "or".
bool TestNone (fType mask) const
 Test multible flags, combine by "not or".
void Set (fType mask)
 Set multiple flags.
void Clr (fType mask)
 Clear multiple flags.
virtual bool IsDefault (void) const
 Test for default value.

Public Attributes

fType mFlags
 Flags (public access for convenience).

Static Public Attributes

static const fType mDefFlags = 0x0

Protected Member Functions

void DoAssign (const AttributeFlags &rSrcAttr)
 Assignment method.
virtual bool DoEqual (const AttributeFlags &rOther) const
 Test equality of configuration data.
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Reads attribute from TokenReader, see Type for public wrappers.
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write to TokenWriter, see Type for public wrappers.
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write to TokenWriter, see Type for public wrappers.

Detailed Description

Boolean flags Attribute.

This attribute class uses a flag word to represent boolean values. The current implementation uses a long int type and hence handles up to 32 flags. Each flag is accessed by the according bit mask.

The current version of libFAUDES uses bits 0,1,2 of event attributes for controllability properties (see AttributeCFlags) and the bits 31 and 32 of state attributes for the Qt based GUI project. Further versions may use the lower 8 bits of the event aflags and the higher 8 bits of state flags. You are free to use any flags for your application, but if possible try to avoid the above mentioned. For extensive use of flags, you may also consider to define a separate attribute class, perhaps with a different fType.

Definition at line 182 of file cfl_attributes.h.


Constructor & Destructor Documentation

faudes::AttributeFlags::AttributeFlags ( void   )  [inline]

Default constructor.

Definition at line 189 of file cfl_attributes.h.

faudes::AttributeFlags::AttributeFlags ( const AttributeFlags rOther  )  [inline]

Copy constructor.

Definition at line 192 of file cfl_attributes.h.

virtual faudes::AttributeFlags::~AttributeFlags ( void   )  [inline, virtual]

Destructor.

Definition at line 195 of file cfl_attributes.h.


Member Function Documentation

void faudes::AttributeFlags::Clr ( fType  mask  )  [inline]

Clear multiple flags.

Definition at line 225 of file cfl_attributes.h.

void faudes::AttributeFlags::DoAssign ( const AttributeFlags rSrcAttr  )  [protected]

Assignment method.

Parameters:
rSrcAttr Source to assign from

Definition at line 99 of file cfl_attributes.cpp.

bool faudes::AttributeFlags::DoEqual ( const AttributeFlags rOther  )  const [protected, virtual]

Test equality of configuration data.

Parameters:
rOther Other object to compare with.
Returns:
True on match.

Definition at line 107 of file cfl_attributes.cpp.

void faudes::AttributeFlags::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
) [protected, virtual]

Reads attribute from TokenReader, see Type for public wrappers.

Test whether the current token is an integer with base 16. If so, read the token to the flags value. Else, dont take any tokens. The label and context arguments are ignored.

Parameters:
rTr TokenReader to read from
rLabel Section to read
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 1)

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeIosEvent, faudes::AttributeIosState, faudes::AttributeColoredState, faudes::AttributePushdownState, faudes::AttributeGotoState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeSimCondition, and faudes::SimEventAttribute.

Definition at line 140 of file cfl_attributes.cpp.

void faudes::AttributeFlags::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const [protected, virtual]

Write to TokenWriter, see Type for public wrappers.

If not the defult value, write the flag value as base 16 integer token. Else, do nothing. The label and context arguments are ignored.

Parameters:
rTw Reference to TokenWriter
rLabel Label of section to write
pContext Write context to provide contextual information
Exceptions:
Exception 
  • IO errors (id 2)

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeIosEvent, faudes::AttributeIosState, faudes::AttributeColoredState, faudes::AttributePushdownState, faudes::AttributeGotoState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeSimCondition, and faudes::SimEventAttribute.

Definition at line 115 of file cfl_attributes.cpp.

void faudes::AttributeFlags::DoXWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const [protected, virtual]

Write to TokenWriter, see Type for public wrappers.

If not the defult value, write the flags in XML format. Else, do nothing. The label and context arguments are ignored.

Parameters:
rTw Reference to TokenWriter
rLabel Label of section to write
pContext Write context to provide contextual information
Exceptions:
Exception 
  • IO errors (id 2)

Reimplemented from faudes::Type.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::AttributeIosEvent, faudes::AttributeIosState, faudes::AttributeColoredState, and faudes::AttributePushdownState.

Definition at line 127 of file cfl_attributes.cpp.

void faudes::AttributeFlags::Set ( fType  mask  )  [inline]

Set multiple flags.

Definition at line 220 of file cfl_attributes.h.

bool faudes::AttributeFlags::Test ( fType  mask  )  const [inline]

Test a flag.

Definition at line 200 of file cfl_attributes.h.

bool faudes::AttributeFlags::TestAll ( fType  mask  )  const [inline]

Test multible flags, combine by "and".

Definition at line 205 of file cfl_attributes.h.

bool faudes::AttributeFlags::TestNone ( fType  mask  )  const [inline]

Test multible flags, combine by "not or".

Definition at line 215 of file cfl_attributes.h.

bool faudes::AttributeFlags::TestSome ( fType  mask  )  const [inline]

Test multible flags, combine by "or".

Definition at line 210 of file cfl_attributes.h.


Member Data Documentation

Definition at line 236 of file cfl_attributes.h.

Flags (public access for convenience).

Definition at line 230 of file cfl_attributes.h.


The documentation for this class was generated from the following files:

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen