#include <iop_vdevice.h>

Public Member Functions

 AttributeDeviceEvent (void)
 
 AttributeDeviceEvent (const AttributeDeviceEvent &rOtherAttr)
 
virtual ~AttributeDeviceEvent (void)
 
virtual void Clear (void)
 
virtual bool IsDefault (void) const
 
bool IsOutput (void) const
 
bool IsInput (void) const
 
void DefaultOutput (void)
 
void DefaultInput (void)
 
virtual void Output (const AttributeVoid &rOutputAttribute)
 
virtual void Input (const AttributeVoid &rInputAttribute)
 
virtual void ReadOutput (TokenReader &rTr)
 
virtual void ReadInput (TokenReader &rTr)
 
const AttributeVoidOutputp (void) const
 
const AttributeVoidInputp (void) const
 
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 
 AttributeVoid (const AttributeVoid &rSrcAttr)
 
virtual ~AttributeVoid (void)
 
virtual void SetDefault (void)
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
- Public Member Functions inherited from faudes::Type
 Type (void)
 
 Type (const Type &rType)
 
virtual ~Type (void)
 
virtual TypeNew (void) const
 
virtual TypeCopy (void) const
 
virtual const TypeCast (const Type *pOther) const
 
virtual TypeAssign (const Type &rSrc)
 
Typeoperator= (const Type &rSrc)
 
virtual bool Equal (const Type &rOther) const
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
virtual void Name (const std::string &rName)
 
virtual const std::string & Name (void) const
 
virtual const std::string & TypeName (void) const
 
void Write (const Type *pContext=0) const
 
void Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 
void XWrite (const Type *pContext=0) const
 
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 
void DWrite (const Type *pContext=0) const
 
void DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
void SWrite (TokenWriter &rTw) const
 
void SWrite (void) const
 
std::string ToSText (void) const
 
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 

Protected Member Functions

void DoAssign (const AttributeDeviceEvent &rSrcAttr)
 
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
- Protected Member Functions inherited from faudes::AttributeVoid
void DoAssign (const AttributeVoid &rSrcAttr)
 
bool DoEqual (const AttributeVoid &rOther) const
 
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
- Protected Member Functions inherited from faudes::Type
void DoAssign (const Type &rSrc)
 
bool DoEqual (const Type &rOther) const
 
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
virtual void DoSWrite (TokenWriter &rTw) const
 
virtual const TypeDefinitionTypeDefinitionp (void) const
 
virtual Token XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const
 

Static Protected Member Functions

static const AttributeVoidFallbackAttributep (void)
 

Protected Attributes

AttributeVoidmpOutputAttribute
 
AttributeVoidmpInputAttribute
 
const AttributeVoidpOutputPrototype
 
const AttributeVoidpInputPrototype
 

Additional Inherited Members

- Static Public Member Functions inherited from faudes::AttributeVoid
static void Skip (TokenReader &rTr)
 

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

◆ AttributeDeviceEvent() [1/2]

faudes::AttributeDeviceEvent::AttributeDeviceEvent ( void  )

Default constructor (no attributes, aka undefined)

Definition at line 43 of file iop_vdevice.cpp.

◆ AttributeDeviceEvent() [2/2]

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

Copy constructor

Definition at line 56 of file iop_vdevice.cpp.

◆ ~AttributeDeviceEvent()

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

Destructor

Definition at line 70 of file iop_vdevice.cpp.

Member Function Documentation

◆ Clear()

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

Clear

Reimplemented from faudes::AttributeVoid.

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

Definition at line 82 of file iop_vdevice.cpp.

◆ DefaultInput()

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

Set to default input attribute

Definition at line 103 of file iop_vdevice.h.

◆ DefaultOutput()

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

Set to default output attribute

Definition at line 97 of file iop_vdevice.h.

◆ DoAssign()

void faudes::AttributeDeviceEvent::DoAssign ( const AttributeDeviceEvent rSrcAttr)
protected

Assignment

Parameters
rSrcAttrSource to copy from
Returns
Ref to this attribute

Definition at line 90 of file iop_vdevice.cpp.

◆ DoRead()

void faudes::AttributeDeviceEvent::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
)
protectedvirtual

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
rTrTokenReader to read from
rLabelSection to read
pContextRead context to provide contextual information
Exceptions
Exception
  • IO error (id 1)

Reimplemented from faudes::AttributeVoid.

Definition at line 108 of file iop_vdevice.cpp.

◆ DoWrite()

void faudes::AttributeDeviceEvent::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const
protectedvirtual

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
rTwTokenWriter to write to
rLabelSection to write
pContextRead context to provide contextual information
Exceptions
Exception
  • IO error (id 2)

Reimplemented from faudes::AttributeVoid.

Definition at line 101 of file iop_vdevice.cpp.

◆ FallbackAttributep()

const AttributeVoid * faudes::AttributeDeviceEvent::FallbackAttributep ( void  )
staticprotected

Fallback attribute type (initialize on first use static construct)

Definition at line 76 of file iop_vdevice.cpp.

◆ Input()

virtual void faudes::AttributeDeviceEvent::Input ( const AttributeVoid rInputAttribute)
inlinevirtual

Set input attribute

Definition at line 115 of file iop_vdevice.h.

◆ Inputp()

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

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

Definition at line 136 of file iop_vdevice.h.

◆ IsDefault()

virtual bool faudes::AttributeDeviceEvent::IsDefault ( void  ) const
inlinevirtual

Test for default value (undefined)

Reimplemented from faudes::AttributeVoid.

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

Definition at line 88 of file iop_vdevice.h.

◆ IsInput()

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

Does this attribute define a input mapping?

Definition at line 94 of file iop_vdevice.h.

◆ IsOutput()

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

Does this attribute define an output mapping?

Definition at line 91 of file iop_vdevice.h.

◆ Output()

virtual void faudes::AttributeDeviceEvent::Output ( const AttributeVoid rOutputAttribute)
inlinevirtual

Set output attribute

Definition at line 109 of file iop_vdevice.h.

◆ Outputp()

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

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

Definition at line 133 of file iop_vdevice.h.

◆ ReadInput()

virtual void faudes::AttributeDeviceEvent::ReadInput ( TokenReader rTr)
inlinevirtual

Read input attribute

Definition at line 127 of file iop_vdevice.h.

◆ ReadOutput()

virtual void faudes::AttributeDeviceEvent::ReadOutput ( TokenReader rTr)
inlinevirtual

Read output attribute

Definition at line 121 of file iop_vdevice.h.

Member Data Documentation

◆ mpInputAttribute

AttributeVoid* faudes::AttributeDeviceEvent::mpInputAttribute
protected

Input Attribute (use cast in derived classes)

Definition at line 145 of file iop_vdevice.h.

◆ mpOutputAttribute

AttributeVoid* faudes::AttributeDeviceEvent::mpOutputAttribute
protected

Output Attribute (use cast in derived classes)

Definition at line 142 of file iop_vdevice.h.

◆ pInputPrototype

const AttributeVoid* faudes::AttributeDeviceEvent::pInputPrototype
protected

Input Prototype (set to nontrivial attribute in derived classes)

Definition at line 151 of file iop_vdevice.h.

◆ pOutputPrototype

const AttributeVoid* faudes::AttributeDeviceEvent::pOutputPrototype
protected

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.33b --- 2025.05.07 --- c++ api documentaion by doxygen