libFAUDES

Sections

Index

faudes::AttributeSimplenetEvent Class Reference

#include <iop_simplenet.h>

Inherits faudes::AttributeDeviceEvent.

List of all members.


Detailed Description

Configuration of a networked sensor or actuator.

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

Definition at line 256 of file iop_simplenet.h.


Public Member Functions

virtual AttributeSimplenetEventNew (void) const
 Construct on heap.
virtual AttributeSimplenetEventCopy (void) const
 Construct on heap.
virtual const
AttributeSimplenetEvent
Cast (const Type *pOther) const
 Cast other object to this type.
virtual AttributeSimplenetEventAssign (const Type &rSrc)
 Assign configuration data from other object.
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data.
virtual AttributeSimplenetEventoperator= (const AttributeSimplenetEvent &rSrc)
virtual bool operator== (const AttributeSimplenetEvent &rOther) const
virtual bool operator!= (const AttributeSimplenetEvent &rOther) const
 AttributeSimplenetEvent (void)
 Default constructor (no mapping at all).
 AttributeSimplenetEvent (const AttributeSimplenetEvent &rOtherAttr)
 Copy constructor.
virtual bool IsDefault (void) const
 Test for default value (never).
virtual void Clear (void)
 Clear.
const AttributeSimplenetActuatorActuatorp (void) const
 Get actuator mapping.
const AttributeSimplenetSensorSensorp (void) const
 Get sensor mapping.

Protected Member Functions

virtual AttributeSimplenetEventDoAssign (const AttributeSimplenetEvent &rSrc)
 DoAssign.

Static Protected Attributes

static AttributeSimplenetSensor sSensorPrototype
 Prototype, sensor.
static AttributeSimplenetActuator sActuatorPrototype
 Prototype, actuator.

Constructor & Destructor Documentation

faudes::AttributeSimplenetEvent::AttributeSimplenetEvent ( void   ) 

Default constructor (no mapping at all).

Definition at line 223 of file iop_simplenet.cpp.

faudes::AttributeSimplenetEvent::AttributeSimplenetEvent ( const AttributeSimplenetEvent rOtherAttr  ) 

Copy constructor.

Definition at line 230 of file iop_simplenet.cpp.


Member Function Documentation

AttributeSimplenetEvent * faudes::AttributeSimplenetEvent::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 220 of file iop_simplenet.cpp.

AttributeSimplenetEvent * faudes::AttributeSimplenetEvent::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 220 of file iop_simplenet.cpp.

const AttributeSimplenetEvent * faudes::AttributeSimplenetEvent::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 220 of file iop_simplenet.cpp.

AttributeSimplenetEvent & faudes::AttributeSimplenetEvent::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 220 of file iop_simplenet.cpp.

bool faudes::AttributeSimplenetEvent::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 220 of file iop_simplenet.cpp.

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

Definition at line 220 of file iop_simplenet.cpp.

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

Definition at line 220 of file iop_simplenet.cpp.

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

Definition at line 220 of file iop_simplenet.cpp.

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

Test for default value (never).

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 269 of file iop_simplenet.h.

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

Clear.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 272 of file iop_simplenet.h.

const AttributeSimplenetActuator* faudes::AttributeSimplenetEvent::Actuatorp ( void   )  const [inline]

Get actuator mapping.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 275 of file iop_simplenet.h.

const AttributeSimplenetSensor* faudes::AttributeSimplenetEvent::Sensorp ( void   )  const [inline]

Get sensor mapping.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 279 of file iop_simplenet.h.

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

DoAssign.

Definition at line 285 of file iop_simplenet.h.


Member Data Documentation

Prototype, sensor.

Definition at line 286 of file iop_simplenet.h.

Prototype, actuator.

Definition at line 292 of file iop_simplenet.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