Detailed Description

Configuration of a networked input or output.

This class is derived from the AttributeDeviceEvent to specialise for networked input and output mapping.

Definition at line 251 of file iop_simplenet.h.

#include <iop_simplenet.h>

Public Member Functions

 AttributeSimplenetEvent (void)
 Default constructor (no mapping at all) More...
 
 AttributeSimplenetEvent (const AttributeSimplenetEvent &rOtherAttr)
 Copy constructor. More...
 
virtual bool IsDefault (void) const
 Test for default value (never) More...
 
virtual void Clear (void)
 Clear. More...
 
const AttributeSimplenetOutputOutputp (void) const
 Get output mapping. More...
 
const AttributeSimplenetInputInputp (void) const
 Get input mapping. More...
 
- Public Member Functions inherited from faudes::AttributeDeviceEvent
 AttributeDeviceEvent (void)
 Default constructor (no attributes, aka undefined) More...
 
 AttributeDeviceEvent (const AttributeDeviceEvent &rOtherAttr)
 Copy constructor. More...
 
virtual ~AttributeDeviceEvent (void)
 Destructor. More...
 
bool IsOutput (void) const
 Does this attribute define an output mapping? More...
 
bool IsInput (void) const
 Does this attribute define a input mapping? More...
 
void DefaultOutput (void)
 Set to default output attribute. More...
 
void DefaultInput (void)
 Set to default input attribute. More...
 
virtual void Output (const AttributeVoid &rOutputAttribute)
 Set output attribute. More...
 
virtual void Input (const AttributeVoid &rInputAttribute)
 Set input attribute. More...
 
virtual void ReadOutput (TokenReader &rTr)
 Read output attribute. More...
 
virtual void ReadInput (TokenReader &rTr)
 Read input attribute. More...
 
const AttributeVoidOutputp (void) const
 Get output mapping (return 0 if its not an output) More...
 
const AttributeVoidInputp (void) const
 Get input mapping (return 0 if its not a input) More...
 
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 Constructor. More...
 
 AttributeVoid (const AttributeVoid &rSrcAttr)
 Copy Constructor. More...
 
virtual ~AttributeVoid (void)
 Destructor. More...
 
virtual void SetDefault (void)
 Set to default value. More...
 
- Public Member Functions inherited from faudes::Type
 Type (void)
 Constructor. More...
 
 Type (const Type &rType)
 Copy constructor. More...
 
virtual ~Type (void)
 Destructor. More...
 
virtual TypeNew (void) const
 Construct on heap. More...
 
virtual TypeCopy (void) const
 Construct on heap. More...
 
virtual const TypeCast (const Type *pOther) const
 Cast other object to this type. More...
 
virtual TypeAssign (const Type &rSrc)
 Assign configuration data from other object. More...
 
virtual Typeoperator= (const Type &rSrc)
 Assign configurationdata from other object. More...
 
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual bool operator== (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual bool operator!= (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual void Name (const std::string &rName)
 Set the objects's name. More...
 
virtual const std::string & Name (void) const
 Get objects's name. More...
 
virtual const std::string & TypeName (void) const
 Get objects's type name. More...
 
void Write (const Type *pContext=0) const
 Write configuration data to console. More...
 
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
 Write configuration data to a file. More...
 
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 Write configuration data to a file. More...
 
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to TokenWriter. More...
 
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to an XML file. More...
 
void XWrite (const Type *pContext=0) const
 Write configuration data in XML format to concole Note: this write function uses the virtual function DoXWrite(), to be reimplemented by derived classes. More...
 
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in XML format to TokenWriter. More...
 
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a string. More...
 
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a formated string. More...
 
void DWrite (const Type *pContext=0) const
 Write configuration data to console, debugging format. More...
 
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
 Write configuration data to a file, debugging format. More...
 
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in debug format to TokenWriter. More...
 
void SWrite (TokenWriter &rTw) const
 Write statistics comment to TokenWriter. More...
 
void SWrite (void) const
 Write statistics comment to console. More...
 
std::string ToSText (void) const
 Write statistics to a string. More...
 
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from file with label specified. More...
 
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from a string. More...
 
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from TokenReader with label sepcified. More...
 

Protected Member Functions

void DoAssign (const AttributeSimplenetEvent &rSrc)
 DoAssign. More...
 
- Protected Member Functions inherited from faudes::AttributeDeviceEvent
void DoAssign (const AttributeDeviceEvent &rSrcAttr)
 Assignment. More...
 
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Reads the attribute from TokenReader, see AttributeVoid for public wrappers. More...
 
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Writes the attribute to TokenWriter, see AttributeVoid for public wrappers. More...
 
- Protected Member Functions inherited from faudes::AttributeVoid
void DoAssign (const AttributeVoid &rSrcAttr)
 Assign attribute members. More...
 
bool DoEqual (const AttributeVoid &rOther) const
 Test equality of configuration data. More...
 
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Actual write method to write the attribute to a TokenWriter. More...
 
- Protected Member Functions inherited from faudes::Type
void DoAssign (const Type &rSrc)
 Assign configuration data from other object. More...
 
bool DoEqual (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data of this object to TokenWriter in XML format. More...
 
virtual void DoSWrite (TokenWriter &rTw) const
 Write statistical data as a comment to TokenWriter. More...
 
virtual const TypeDefinitionTypeDefinitionp (void) const
 Get objects's type definition. More...
 
virtual Token XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const
 

Static Protected Member Functions

static const AttributeSimplenetInputInputPrototypep (void)
 Prototype, input (construct on first use static) More...
 
static const AttributeSimplenetOutputOutputPrototypep (void)
 Prototype, output (construct on first use static) More...
 
- Static Protected Member Functions inherited from faudes::AttributeDeviceEvent
static const AttributeVoidFallbackAttributep (void)
 Fallback attribute type (initialize on first use static construct) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from faudes::AttributeVoid
static void Skip (TokenReader &rTr)
 Skip attribute tokens. More...
 
- Protected Attributes inherited from faudes::AttributeDeviceEvent
AttributeVoidmpOutputAttribute
 Output Attribute (use cast in derived classes) More...
 
AttributeVoidmpInputAttribute
 Input Attribute (use cast in derived classes) More...
 
const AttributeVoidpOutputPrototype
 Output Prototype (set to nontrivial attribute in derived classes) More...
 
const AttributeVoidpInputPrototype
 Input Prototype (set to nontrivial attribute in derived classes) More...
 

Constructor & Destructor Documentation

◆ AttributeSimplenetEvent() [1/2]

faudes::AttributeSimplenetEvent::AttributeSimplenetEvent ( void  )

Default constructor (no mapping at all)

Definition at line 202 of file iop_simplenet.cpp.

◆ AttributeSimplenetEvent() [2/2]

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

Copy constructor.

Definition at line 209 of file iop_simplenet.cpp.

Member Function Documentation

◆ Clear()

virtual void faudes::AttributeSimplenetEvent::Clear ( void  )
inlinevirtual

Clear.

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 267 of file iop_simplenet.h.

◆ DoAssign()

void faudes::AttributeSimplenetEvent::DoAssign ( const AttributeSimplenetEvent rSrc)
inlineprotected

DoAssign.

Definition at line 280 of file iop_simplenet.h.

◆ Inputp()

const AttributeSimplenetInput* faudes::AttributeSimplenetEvent::Inputp ( void  ) const
inline

Get input mapping.

Definition at line 274 of file iop_simplenet.h.

◆ InputPrototypep()

const AttributeSimplenetInput * faudes::AttributeSimplenetEvent::InputPrototypep ( void  )
staticprotected

Prototype, input (construct on first use static)

Definition at line 226 of file iop_simplenet.cpp.

◆ IsDefault()

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

Test for default value (never)

Reimplemented from faudes::AttributeDeviceEvent.

Definition at line 264 of file iop_simplenet.h.

◆ Outputp()

const AttributeSimplenetOutput* faudes::AttributeSimplenetEvent::Outputp ( void  ) const
inline

Get output mapping.

Definition at line 270 of file iop_simplenet.h.

◆ OutputPrototypep()

const AttributeSimplenetOutput * faudes::AttributeSimplenetEvent::OutputPrototypep ( void  )
staticprotected

Prototype, output (construct on first use static)

Definition at line 220 of file iop_simplenet.cpp.


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

libFAUDES 2.32b --- 2024.03.01 --- c++ api documentaion by doxygen