| |
libFAUDES
Sections
Index
|
faudes::AttributeFlags Class Reference#include <attributes.h>
Inherits faudes::AttributeVoid. Inherited by faudes::AttributeCFlags, faudes::AttributeColoredState, faudes::AttributeTimedState, faudes::AttributeTimedTrans, faudes::HioEventFlags, and faudes::HioStateFlags.
Detailed DescriptionBoolean 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.
Constructor & Destructor Documentation
Default constructor.
Destructor.
Member Function Documentation
Construct on heap. Technically not a constructor, this function creates an object with the same type Type. New() is defined as a virtual function and derived classes are meant to re-implement with the appropiate constructor. This can be done via the provided macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION. As with new, it is the callers reponsabilty to delete the object when no longer needed.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeCFlags, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, and faudes::SimEventAttribute.
Cast other object to this type. Enables the run-time interface to test whether pObject is derived from this object. This feature is used e.g. in the faudes container classes to test attributes. Derived classes must reimplement this function using the appropriate dynamic cast.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeCFlags.
Copy attribute. Virtual interface to copy members using a dynamic cast to figure the actual type of the destination. If the latter is known at compiletime, performance is better via the assignment operator.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeColoredState.
Test a flag.
Test multible flags, combine by "and".
Test multible flags, combine by "or".
Test multible flags, combine by "not or".
Set multiple flags.
Clear multiple flags.
Test for default value.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeCFlags, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, and faudes::SimEventAttribute.
Copy all attribute members.
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.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeCFlags, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, and faudes::SimEventAttribute.
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.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeCFlags, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, and faudes::SimEventAttribute.
Member Data DocumentationFlags (public access for convenience).
The documentation for this class was generated from the following files: |
libFAUDES 2.13a c++ source docu by doxygen 1.5.6