libFAUDES

Sections

Index

faudes::AttributeSignalEvent Class Reference

#include <iop_sdevice.h>

Inherits faudes::AttributeDeviceEvent.

List of all members.


Detailed Description

Configuration of a signal based sensor or actuator.

This class is derived from the AttributeDeviceEvent to specialise for signal based sensor and actuator mapping.

Definition at line 221 of file iop_sdevice.h.


Public Member Functions

virtual AttributeSignalEventNew (void) const
 Construct on heap.
virtual AttributeSignalEventCopy (void) const
 Construct on heap.
virtual const
AttributeSignalEvent
Cast (const Type *pOther) const
 Cast other object to this type.
virtual AttributeSignalEventAssign (const Type &rSrc)
 Assign configuration data from other object.
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data.
virtual AttributeSignalEventoperator= (const AttributeSignalEvent &rSrc)
virtual bool operator== (const AttributeSignalEvent &rOther) const
virtual bool operator!= (const AttributeSignalEvent &rOther) const
 AttributeSignalEvent (void)
 Default constructor (no mapping at all).
 AttributeSignalEvent (const AttributeSignalEvent &rOtherAttr)
 Copy constructor.
virtual bool IsDefault (void) const
 Test for default value (never).
virtual void Clear (void)
 Clear.
const AttributeSignalActuatorActuatorp (void) const
 Get actuator mapping.
const AttributeSignalSensorSensorp (void) const
 Get sensor mapping.

Protected Member Functions

virtual AttributeSignalEventDoAssign (const AttributeSignalEvent &rSrc)
 DoAssign.

Static Protected Attributes

static AttributeSignalSensor sSensorPrototype
 Prototype, sensor.
static AttributeSignalActuator sActuatorPrototype
 Prototype, actuator.

Constructor & Destructor Documentation

faudes::AttributeSignalEvent::AttributeSignalEvent ( void   ) 

Default constructor (no mapping at all).

Definition at line 241 of file iop_sdevice.cpp.

faudes::AttributeSignalEvent::AttributeSignalEvent ( const AttributeSignalEvent rOtherAttr  ) 

Copy constructor.

Definition at line 248 of file iop_sdevice.cpp.


Member Function Documentation

AttributeSignalEvent * faudes::AttributeSignalEvent::New ( void   )  const [virtual]

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.

Returns:
Pointer to new Type object

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 238 of file iop_sdevice.cpp.

AttributeSignalEvent * faudes::AttributeSignalEvent::Copy ( void   )  const [virtual]

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.

Returns:
Pointer to new Type object

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 238 of file iop_sdevice.cpp.

const AttributeSignalEvent * faudes::AttributeSignalEvent::Cast ( const Type pOther  )  const [virtual]

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.

Returns:
Typed pointer object

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 238 of file iop_sdevice.cpp.

AttributeSignalEvent & faudes::AttributeSignalEvent::Assign ( const Type rSrc  )  [virtual]

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.

Parameters:
rSrc Source to copy from
Returns:
Reference to this object.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 238 of file iop_sdevice.cpp.

bool faudes::AttributeSignalEvent::Equal ( const Type rOther  )  const [virtual]

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.

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

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 238 of file iop_sdevice.cpp.

AttributeSignalEvent & faudes::AttributeSignalEvent::operator= ( const AttributeSignalEvent rSrc  )  [virtual]

Definition at line 238 of file iop_sdevice.cpp.

bool faudes::AttributeSignalEvent::operator== ( const AttributeSignalEvent rOther  )  const [virtual]

Definition at line 238 of file iop_sdevice.cpp.

bool faudes::AttributeSignalEvent::operator!= ( const AttributeSignalEvent rOther  )  const [virtual]

Definition at line 238 of file iop_sdevice.cpp.

virtual bool faudes::AttributeSignalEvent::IsDefault ( void   )  const [inline, virtual]

Test for default value (never).

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 234 of file iop_sdevice.h.

virtual void faudes::AttributeSignalEvent::Clear ( void   )  [inline, virtual]

Clear.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 237 of file iop_sdevice.h.

const AttributeSignalActuator* faudes::AttributeSignalEvent::Actuatorp ( void   )  const [inline]

Get actuator mapping.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 240 of file iop_sdevice.h.

const AttributeSignalSensor* faudes::AttributeSignalEvent::Sensorp ( void   )  const [inline]

Get sensor mapping.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 244 of file iop_sdevice.h.

virtual AttributeSignalEvent& faudes::AttributeSignalEvent::DoAssign ( const AttributeSignalEvent rSrc  )  [inline, protected, virtual]

DoAssign.

Definition at line 250 of file iop_sdevice.h.


Member Data Documentation

Prototype, sensor.

Definition at line 251 of file iop_sdevice.h.

Prototype, actuator.

Definition at line 257 of file iop_sdevice.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