libFAUDES

Sections

Index

faudes::AttributeSimplenetActuator Class Reference

#include <iop_simplenet.h>

Inherits faudes::AttributeVoid.

List of all members.


Detailed Description

Configuration of a network actuator mapping.

There is nothing to configure here: any client that connects to this device can subscribe to any actuator event. Future versions of libFAUDES may specify a set of receipent clients.

Definition at line 101 of file iop_simplenet.h.


Public Member Functions

virtual
AttributeSimplenetActuator
New (void) const
 Construct on heap.
virtual
AttributeSimplenetActuator
Copy (void) const
 Construct on heap.
virtual const
AttributeSimplenetActuator
Cast (const Type *pOther) const
 Cast other object to this type.
virtual
AttributeSimplenetActuator
Assign (const Type &rSrc)
 Assign configuration data from other object.
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data.
virtual
AttributeSimplenetActuator
operator= (const AttributeSimplenetActuator &rSrc)
virtual bool operator== (const AttributeSimplenetActuator &rOther) const
virtual bool operator!= (const AttributeSimplenetActuator &rOther) const
 AttributeSimplenetActuator (void)
 Default constructor.
virtual bool IsDefault (void) const
 Test for default value (never).
virtual void Clear (void)
 Clear to default.

Protected Member Functions

virtual
AttributeSimplenetActuator
DoAssign (const AttributeSimplenetActuator &rSrcAttr)
 Copy method.
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Reads the attribute from TokenReader, see AttributeVoid for public wrappers.
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.

Constructor & Destructor Documentation

faudes::AttributeSimplenetActuator::AttributeSimplenetActuator ( void   )  [inline]

Default constructor.

Definition at line 108 of file iop_simplenet.h.


Member Function Documentation

AttributeSimplenetActuator * faudes::AttributeSimplenetActuator::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::AttributeVoid.

Definition at line 128 of file iop_simplenet.cpp.

AttributeSimplenetActuator * faudes::AttributeSimplenetActuator::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::AttributeVoid.

Definition at line 128 of file iop_simplenet.cpp.

const AttributeSimplenetActuator * faudes::AttributeSimplenetActuator::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::AttributeVoid.

Definition at line 128 of file iop_simplenet.cpp.

AttributeSimplenetActuator & faudes::AttributeSimplenetActuator::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::AttributeVoid.

Definition at line 128 of file iop_simplenet.cpp.

bool faudes::AttributeSimplenetActuator::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::AttributeVoid.

Definition at line 128 of file iop_simplenet.cpp.

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

Definition at line 128 of file iop_simplenet.cpp.

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

Definition at line 128 of file iop_simplenet.cpp.

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

Definition at line 128 of file iop_simplenet.cpp.

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

Test for default value (never).

Reimplemented from faudes::AttributeVoid.

Definition at line 111 of file iop_simplenet.h.

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

Clear to default.

Reimplemented from faudes::AttributeVoid.

Definition at line 114 of file iop_simplenet.h.

virtual AttributeSimplenetActuator& faudes::AttributeSimplenetActuator::DoAssign ( const AttributeSimplenetActuator rSrcAttr  )  [inline, protected, virtual]

Copy method.

Parameters:
rSrcAttr Source to copy from
Returns:
Ref to this attribute

Definition at line 125 of file iop_simplenet.h.

void faudes::AttributeSimplenetActuator::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
) [protected, virtual]

Reads the attribute from TokenReader, see AttributeVoid for public wrappers.

If the current token indicates a sensor mapping, 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, we use the hardcoded section "Actuator" for actuator attributes. The context argument is ignored.

Parameters:
rTr TokenReader to read from
rLabel Section to read
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 1)

Reimplemented from faudes::AttributeVoid.

Definition at line 140 of file iop_simplenet.cpp.

void faudes::AttributeSimplenetActuator::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const [protected, virtual]

Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.

Writes the actuator mapping data. The label argument is ignored, we use the hardcoded section "Actuator". The context argument is ignored.

Parameters:
rTw TokenWriter to write to
rLabel Section to write
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 2)

Reimplemented from faudes::AttributeVoid.

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