faudes::AttributeSignalOutput Class Reference

Configuration of a signal based output mapping. More...

#include <iop_sdevice.h>

List of all members.

Classes

class  Action
 Typedef for a single output action. More...

Public Types

enum  Value { Set, Clr, Inv }
 

Enum for action.

More...

Public Member Functions

 AttributeSignalOutput (void)
 Default constructor (no actions at all).
 AttributeSignalOutput (const AttributeSignalOutput &rOtherAttr)
 Copy - constructor.
virtual bool IsDefault (void) const
 Test for default value (never).
virtual void Clear (void)
 Clear.

Public Attributes

std::vector< ActionmActions
 List of actions to perform.

Protected Member Functions

virtual void DoAssign (const AttributeSignalOutput &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.

Detailed Description

Configuration of a signal based output mapping.

An output mapping consists of a list of actions that to be performed when the event is executed. Each action may set or clear the physical output line specified by an abstract bitaddress.

Definition at line 33 of file iop_sdevice.h.


Member Enumeration Documentation

Enum for action.

Enumerator:
Set 
Clr 
Inv 

Definition at line 53 of file iop_sdevice.h.


Constructor & Destructor Documentation

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

Default constructor (no actions at all).

Definition at line 40 of file iop_sdevice.h.

faudes::AttributeSignalOutput::AttributeSignalOutput ( const AttributeSignalOutput rOtherAttr  )  [inline]

Copy - constructor.

Definition at line 43 of file iop_sdevice.h.


Member Function Documentation

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

Clear.

Reimplemented from faudes::AttributeVoid.

Definition at line 50 of file iop_sdevice.h.

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

Copy method.

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

Definition at line 36 of file iop_sdevice.cpp.

void faudes::AttributeSignalOutput::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 output 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 the hardcoded output for output device 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 64 of file iop_sdevice.cpp.

void faudes::AttributeSignalOutput::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 output mapping data. The label argument is ignored, we use the hardcoded section "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 42 of file iop_sdevice.cpp.

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

Test for default value (never).

Reimplemented from faudes::AttributeVoid.

Definition at line 47 of file iop_sdevice.h.


Member Data Documentation

List of actions to perform.

Definition at line 64 of file iop_sdevice.h.


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

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