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.

#include <iop_sdevice.h>

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) More...

	AttributeSignalOutput (const AttributeSignalOutput &rOtherAttr)
	Copy - constructor. More...

virtual bool	IsDefault (void) const
	Test for default value (never) More...

virtual void	Clear (void)
	Clear. 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 Type *	New (void) const
	Construct on heap. More...

virtual Type *	Copy (void) const
	Construct on heap. More...

virtual const Type *	Cast (const Type *pOther) const
	Cast other object to this type. More...

virtual Type &	Assign (const Type &rSrc)
	Assign configuration data from other object. More...

virtual Type &	operator= (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...

Public Attributes
std::vector< Action >	mActions
	List of actions to perform. More...

Protected Member Functions
void	DoAssign (const AttributeSignalOutput &rSrcAttr)
	Copy method. 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 TypeDefinition *	TypeDefinitionp (void) const
	Get objects's type definition. More...

virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Additional Inherited Members
Static Public Member Functions inherited from faudes::AttributeVoid
static void	Skip (TokenReader &rTr)
	Skip attribute tokens. More...

Member Enumeration Documentation

◆ Value

enum faudes::AttributeSignalOutput::Value

Enum for action

Enumerator
Set
Clr
Inv

Definition at line 53 of file iop_sdevice.h.

Constructor & Destructor Documentation

◆ AttributeSignalOutput() [1/2]

faudes::AttributeSignalOutput::AttributeSignalOutput ( void )

inline

Default constructor (no actions at all)

Definition at line 40 of file iop_sdevice.h.

◆ AttributeSignalOutput() [2/2]

faudes::AttributeSignalOutput::AttributeSignalOutput ( const AttributeSignalOutput & rOtherAttr )

inline

Copy - constructor.

Definition at line 43 of file iop_sdevice.h.

Member Function Documentation

◆ Clear()

virtual void faudes::AttributeSignalOutput::Clear ( void )

inlinevirtual

Clear.

Reimplemented from faudes::AttributeVoid.

Definition at line 50 of file iop_sdevice.h.

◆ DoAssign()

void faudes::AttributeSignalOutput::DoAssign ( const AttributeSignalOutput & rSrcAttr )

protected

Copy method.

Parameters

rSrcAttr Source to copy from

Returns: Ref to this attribute

Definition at line 35 of file iop_sdevice.cpp.

◆ DoRead()

void faudes::AttributeSignalOutput::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 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 63 of file iop_sdevice.cpp.

◆ DoWrite()

void faudes::AttributeSignalOutput::DoWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)		const

protectedvirtual

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 41 of file iop_sdevice.cpp.

◆ IsDefault()

virtual bool faudes::AttributeSignalOutput::IsDefault ( void ) const

inlinevirtual

Test for default value (never)

Reimplemented from faudes::AttributeVoid.

Definition at line 47 of file iop_sdevice.h.

Member Data Documentation

◆ mActions

std::vector<Action> faudes::AttributeSignalOutput::mActions

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:

Detailed Description

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ Value

Constructor & Destructor Documentation

◆ AttributeSignalOutput() [1/2]

◆ AttributeSignalOutput() [2/2]

Member Function Documentation

◆ Clear()

◆ DoAssign()

◆ DoRead()

◆ DoWrite()

◆ IsDefault()

Member Data Documentation

◆ mActions