| |
libFAUDES
Sections
Index
|
faudes::AttributeDeviceEvent Class Reference#include <iop_vdevice.h>
Inherits faudes::AttributeVoid. Inherited by faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent.
Detailed DescriptionAttribute for the configuration of a sensor or actuator mapping.The base class for all device event attributes only distinguishes between actuator and sensor events. The actual attribute is of type AttributeVoid. Derived classes are meant to override this type in order to provide the defining data for the actual mapping of physical and logical events. Definition at line 62 of file iop_vdevice.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::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 47 of file iop_vdevice.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::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 47 of file iop_vdevice.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::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 47 of file iop_vdevice.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::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 47 of file iop_vdevice.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::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 47 of file iop_vdevice.cpp.
Definition at line 47 of file iop_vdevice.cpp.
Definition at line 47 of file iop_vdevice.cpp.
Definition at line 47 of file iop_vdevice.cpp.
Clear.
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 79 of file iop_vdevice.cpp.
Test for default value (undefined).
Reimplemented from faudes::AttributeVoid. Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 80 of file iop_vdevice.h.
Get actuator mapping (return 0 if its not an actuator).
Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 113 of file iop_vdevice.h.
Get sensor mapping (return 0 if its not a sensor).
Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent. Definition at line 116 of file iop_vdevice.h.
Copy method.
Definition at line 87 of file iop_vdevice.cpp.
Reads the attribute from TokenReader, see AttributeVoid for public wrappers. If the current token indicates a "Sensor" or "Actuator" section, the method reads that section. Else it does nothing. Exceptions may only be thrown on invalid data within the section. The label argument is ignored. The context argument is ignored.
Reimplemented from faudes::AttributeVoid. Definition at line 106 of file iop_vdevice.cpp.
Writes the attribute to TokenWriter, see AttributeVoid for public wrappers. Writes all present device event attributes to include the defining data. The label argument is ignored, we use hardcoded lebels "Sensor" or "Actuator". The context argument is ignored.
Reimplemented from faudes::AttributeVoid. Definition at line 99 of file iop_vdevice.cpp.
Member Data DocumentationActuator Prototype (set to nontrivial attribute in derived classes).
Definition at line 128 of file iop_vdevice.h. Sensor Prototype (set to nontrivial attribute in derived classes).
Definition at line 131 of file iop_vdevice.h.
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