| |
libFAUDES
Sections
Index
|
faudes::AttributeVoid Class Reference#include <attributes.h>
Inherits faudes::Type. Inherited by faudes::AttributeDeviceEvent, faudes::AttributeFlags, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeTimedGlobal, and faudes::SimConditionAttribute.
Detailed DescriptionMinimal Attribute.Attributes are used as template parameters for faudes containers and generators and facilitate the modelling of customized properties of events, states and transitions. The AttributeVoid class defines the minimal interface of faudes attributes and therefore is the designated base class for all attribute implementations. The AttributeVoid class does not define any actual properties. See AttributeFlags for a non-trivial example. To derive a class from AttributeVoid you should reimplement the virtual interface
Definition at line 51 of file attributes.h.
Constructor & Destructor Documentation
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::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 35 of file attributes.cpp.
Construct on heap. Technically not a constructor, this function creates an object with the same type Type and the same configuration. Copy() is defined as a virtual function and derived classes are meant to re-implement with the appropiate copy 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::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 35 of file attributes.cpp.
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. Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 35 of file attributes.cpp.
Assign configuration data from other object. Derived classes should reimplement this method to first try to cast the source to the respective class. If successful, the protected function DoAssign is invoked to perform the actual assignment. If the cast fails, the Assign method of the parent class is called. Thus, faudes objects are up- and downcatsted for assignment, maintaining as much of the source data as digestable by the destination object. On the downside, there is no sensible typechecking at compile-time. Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 35 of file attributes.cpp.
Test equality of configuration data. Derived classes should reimplement this method to return true if both actual types and configuration data match. The object name is not consired in the test. This method calls the virtual method DoEqual(). Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 35 of file attributes.cpp.
Definition at line 35 of file attributes.cpp.
Definition at line 35 of file attributes.cpp.
Definition at line 35 of file attributes.cpp.
Test for default value.
Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 66 of file attributes.h.
Set to default value. Derived classes must reimplement this function for Clear to operate properly. Definition at line 72 of file attributes.h.
Synonym for SetDefault to match std interface.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSignalEvent, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, faudes::AttributeSimplenetEvent, and faudes::AttributeDeviceEvent. Definition at line 77 of file attributes.h.
Skip attribute tokens. Helper method to be called after all sttribute derived classes had their chance to read their data. It skips all tokens and sections until it reaches a String or decimal Integer.
Definition at line 60 of file attributes.cpp.
Assign attribute members. Since AttributeVoid has no members, this method does nothing. Derived classes are meant to reimplement DoAssign by first calling their base and then assigning additional member variables.
Definition at line 104 of file attributes.h.
Test equality of configuration data. Derived attributes should reimplement this class to compare configuration data. The base AttributeVoid returns true as a default.
Definition at line 115 of file attributes.h.
Actual read method to read attribute from tokenreader. For derived attributue classes, this method must either read all tokens that belong to the respective attribute, or none. It may throw exceptions on token mismatch within the relevant attribute, but it may not throw exceptions when it encounters tokens that possibly belong to another attribute. The latter are to be skipped by the provided Skip method. See Type::Read for public wrappers.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, and faudes::AttributeDeviceEvent. Definition at line 54 of file attributes.cpp.
Actual write method to write the attribute to a TokenWriter. Reimplement this method for derived attribute classes to define the token io format. See Type::Write for public wrappers.
Reimplemented from faudes::Type. Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeColoredState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::SimConditionAttribute, faudes::SimEventAttribute, faudes::AttributeSignalActuator, faudes::AttributeSignalSensor, faudes::AttributeSimplenetActuator, faudes::AttributeSimplenetSensor, and faudes::AttributeDeviceEvent. Definition at line 48 of file attributes.cpp.
The documentation for this class was generated from the following files: |
libFAUDES 2.14g --- 2009-12-3 --- c++ source docu by doxygen 1.5.6