faudes::AttributeDeviceEvent Class Reference

Attribute for the configuration of a input or output mapping. More...

#include <iop_vdevice.h>

List of all members.

Public Member Functions

 AttributeDeviceEvent (void)
 Default constructor (no attributes, aka undefined).
 AttributeDeviceEvent (const AttributeDeviceEvent &rOtherAttr)
 Copy constructor.
virtual ~AttributeDeviceEvent (void)
 Destructor.
virtual void Clear (void)
 Clear.
virtual bool IsDefault (void) const
 Test for default value (undefined).
bool IsOutput (void) const
 Does this attribute define an output mapping?
bool IsInput (void) const
 Does this attribute define a input mapping?
void DefaultOutput (void)
 Set to default output attribute.
void DefaultInput (void)
 Set to default input attribute.
virtual void Output (const AttributeVoid &rOutputAttribute)
 Set output attribute.
virtual void Input (const AttributeVoid &rInputAttribute)
 Set input attribute.
virtual void ReadOutput (TokenReader &rTr)
 Read output attribute.
virtual void ReadInput (TokenReader &rTr)
 Read input attribute.
const AttributeVoidOutputp (void) const
 Get output mapping (return 0 if its not an output).
const AttributeVoidInputp (void) const
 Get input mapping (return 0 if its not a input).

Protected Member Functions

virtual void DoAssign (const AttributeDeviceEvent &rSrcAttr)
 Assignment.
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.

Static Protected Member Functions

static const AttributeVoidFallbackAttributep (void)
 Fallback attribute type (initialize on first use static construct).

Protected Attributes

AttributeVoidmpOutputAttribute
 Output Attribute (use cast in derived classes).
AttributeVoidmpInputAttribute
 Input Attribute (use cast in derived classes).
const AttributeVoidpOutputPrototype
 Output Prototype (set to nontrivial attribute in derived classes).
const AttributeVoidpInputPrototype
 Input Prototype (set to nontrivial attribute in derived classes).

Detailed Description

Attribute for the configuration of a input or output mapping.

The base class for all device event attributes only distinguishes between output and input 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 68 of file iop_vdevice.h.


Constructor & Destructor Documentation

faudes::AttributeDeviceEvent::AttributeDeviceEvent ( void   ) 

Default constructor (no attributes, aka undefined).

Definition at line 43 of file iop_vdevice.cpp.

faudes::AttributeDeviceEvent::AttributeDeviceEvent ( const AttributeDeviceEvent rOtherAttr  ) 

Copy constructor.

Definition at line 56 of file iop_vdevice.cpp.

faudes::AttributeDeviceEvent::~AttributeDeviceEvent ( void   )  [virtual]

Destructor.

Definition at line 70 of file iop_vdevice.cpp.


Member Function Documentation

void faudes::AttributeDeviceEvent::Clear ( void   )  [virtual]

Clear.

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent.

Definition at line 82 of file iop_vdevice.cpp.

void faudes::AttributeDeviceEvent::DefaultInput ( void   )  [inline]

Set to default input attribute.

Definition at line 103 of file iop_vdevice.h.

void faudes::AttributeDeviceEvent::DefaultOutput ( void   )  [inline]

Set to default output attribute.

Definition at line 97 of file iop_vdevice.h.

void faudes::AttributeDeviceEvent::DoAssign ( const AttributeDeviceEvent rSrcAttr  )  [protected, virtual]

Assignment.

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

Definition at line 90 of file iop_vdevice.cpp.

void faudes::AttributeDeviceEvent::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 an "Input" or "Output" 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.

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 108 of file iop_vdevice.cpp.

void faudes::AttributeDeviceEvent::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 all present device event attributes to include the defining data. The label argument is ignored, we use hardcoded labels "Input" or "Output". 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 101 of file iop_vdevice.cpp.

const AttributeVoid * faudes::AttributeDeviceEvent::FallbackAttributep ( void   )  [static, protected]

Fallback attribute type (initialize on first use static construct).

Definition at line 76 of file iop_vdevice.cpp.

virtual void faudes::AttributeDeviceEvent::Input ( const AttributeVoid rInputAttribute  )  [inline, virtual]

Set input attribute.

Definition at line 115 of file iop_vdevice.h.

const AttributeVoid* faudes::AttributeDeviceEvent::Inputp ( void   )  const [inline]

Get input mapping (return 0 if its not a input).

Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent.

Definition at line 136 of file iop_vdevice.h.

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

Test for default value (undefined).

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent.

Definition at line 88 of file iop_vdevice.h.

bool faudes::AttributeDeviceEvent::IsInput ( void   )  const [inline]

Does this attribute define a input mapping?

Definition at line 94 of file iop_vdevice.h.

bool faudes::AttributeDeviceEvent::IsOutput ( void   )  const [inline]

Does this attribute define an output mapping?

Definition at line 91 of file iop_vdevice.h.

virtual void faudes::AttributeDeviceEvent::Output ( const AttributeVoid rOutputAttribute  )  [inline, virtual]

Set output attribute.

Definition at line 109 of file iop_vdevice.h.

const AttributeVoid* faudes::AttributeDeviceEvent::Outputp ( void   )  const [inline]

Get output mapping (return 0 if its not an output).

Reimplemented in faudes::AttributeSignalEvent, and faudes::AttributeSimplenetEvent.

Definition at line 133 of file iop_vdevice.h.

virtual void faudes::AttributeDeviceEvent::ReadInput ( TokenReader rTr  )  [inline, virtual]

Read input attribute.

Definition at line 127 of file iop_vdevice.h.

virtual void faudes::AttributeDeviceEvent::ReadOutput ( TokenReader rTr  )  [inline, virtual]

Read output attribute.

Definition at line 121 of file iop_vdevice.h.


Member Data Documentation

Input Attribute (use cast in derived classes).

Definition at line 145 of file iop_vdevice.h.

Output Attribute (use cast in derived classes).

Definition at line 136 of file iop_vdevice.h.

Input Prototype (set to nontrivial attribute in derived classes).

Definition at line 151 of file iop_vdevice.h.

Output Prototype (set to nontrivial attribute in derived classes).

Definition at line 148 of file iop_vdevice.h.


The documentation for this class was generated from the following files:

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen