Detailed Description

Attributes for events in DES with in- and outputs.

The class AttributeIosEvent holds a bitarray to handle an event's io-properties

In order to envolve the event's io-properties during file-io the DoRead/DoWrite methods were overwritten. Use Attributes +I+ and +O+ in .gen file to make sure an event will be inserted in Iput or OTput event set.

<>

Definition at line 39 of file ios_attributes.h.

#include <ios_attributes.h>

Public Member Functions
	AttributeIosEvent (void)
	Default constructor. More...

	AttributeIosEvent (const AttributeIosEvent &rSrc)
	Copy constructor. More...

virtual	~AttributeIosEvent (void)
	Destructor. More...

void	SetOutput (void)
	Set output flag. More...

void	ClrOutput (void)
	Clear output flag. More...

void	SetInput (void)
	Set input flag. More...

void	ClrInput (void)
	Clear input flag. More...

bool	Output (void) const
	Test output flag. More...

bool	Input (void) const
	Test input flag. More...

bool	IsDefault (void) const
	Check an event's io-properties for default value. More...

Public Member Functions inherited from faudes::AttributeFlags
	AttributeFlags (void)
	Default constructor. More...

	AttributeFlags (const AttributeFlags &rOther)
	Copy constructor. More...

virtual	~AttributeFlags (void)
	Destructor. More...

bool	Test (fType mask) const
	Test a flag. More...

bool	TestAll (fType mask) const
	Test multible flags, combine by "and". More...

bool	TestSome (fType mask) const
	Test multible flags, combine by "or". More...

bool	TestNone (fType mask) const
	Test multible flags, combine by "not or". More...

void	Set (fType mask)
	Set multiple flags. More...

void	Clr (fType mask)
	Clear multiple flags. 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...

virtual void	Clear (void)
	Synonym for SetDefault to match std interface. 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...

Protected Member Functions
void	DoAssign (const AttributeIosEvent &rSrcAttr)
	Assignment method. More...

virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Reads attribute from TokenReader, see AttributeVoid for public wrappers. More...

virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Writes attribute to TokenWriter, see AttributeVoid for public wrappers. More...

virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Writes attribute to TokenWriter, see AttributeVoid for public wrappers. More...

Protected Member Functions inherited from faudes::AttributeFlags
void	DoAssign (const AttributeFlags &rSrcAttr)
	Assignment method. More...

bool	DoEqual (const AttributeFlags &rOther) const
	Test equality of configuration data. 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	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

Static Protected Attributes
static const fType	mInputFlag =0x010

static const fType	mOutputFlag =0x020

static const fType	mDefIosFlags =0x000

static const fType	mAllIosFlags =0x030

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

Public Attributes inherited from faudes::AttributeFlags
fType	mFlags
	Flags (public access for convenience) More...

Static Public Attributes inherited from faudes::AttributeFlags
static const fType	mDefFlags =0x0

Constructor & Destructor Documentation

◆ AttributeIosEvent() [1/2]

faudes::AttributeIosEvent::AttributeIosEvent ( void )

inline

Default constructor.

Definition at line 49 of file ios_attributes.h.

◆ AttributeIosEvent() [2/2]

faudes::AttributeIosEvent::AttributeIosEvent ( const AttributeIosEvent & rSrc )

inline

Copy constructor.

Definition at line 56 of file ios_attributes.h.

◆ ~AttributeIosEvent()

virtual faudes::AttributeIosEvent::~AttributeIosEvent ( void )

inlinevirtual

Destructor.

Definition at line 63 of file ios_attributes.h.

Member Function Documentation

◆ ClrInput()

void faudes::AttributeIosEvent::ClrInput ( void )

inline

Clear input flag.

Note: this will clear the input flag.

Definition at line 103 of file ios_attributes.h.

◆ ClrOutput()

void faudes::AttributeIosEvent::ClrOutput ( void )

inline

Clear output flag.

Note: this will clear the input flag.

Definition at line 82 of file ios_attributes.h.

◆ DoAssign()

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

protected

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 36 of file ios_attributes.cpp.

◆ DoRead()

void faudes::AttributeIosEvent::DoRead	(	TokenReader &	rTr,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)

protectedvirtual

Reads attribute from TokenReader, see AttributeVoid for public wrappers.

Reads a single token if it can be interpreted as IosEventFlag, that is, if it is a respective option string or hex number. Label and Context argument are ignored. No token mismatch exceptions are thrown on error.

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::AttributeFlags.

Definition at line 103 of file ios_attributes.cpp.

◆ DoWrite()

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

protectedvirtual

Writes attribute to TokenWriter, see AttributeVoid for public wrappers.

Label and Context argument are ignored.

Parameters

rTw	TokenWriter to write to
rLabel	Section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 43 of file ios_attributes.cpp.

◆ DoXWrite()

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

protectedvirtual

Writes attribute to TokenWriter, see AttributeVoid for public wrappers.

Label and Context argument are ignored.

Parameters

rTw	TokenWriter to write to
rLabel	Section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 77 of file ios_attributes.cpp.

◆ Input()

bool faudes::AttributeIosEvent::Input ( void ) const

inline

Test input flag.

Returns: true: state is an input state false: state is not an input state

Definition at line 126 of file ios_attributes.h.

◆ IsDefault()

bool faudes::AttributeIosEvent::IsDefault ( void ) const

inlinevirtual

Check an event's io-properties for default value.

If an event has default properties, it's wether an input nor to output event.

Returns: true: event has default properties false: event has non-default properties

Reimplemented from faudes::AttributeFlags.

Definition at line 142 of file ios_attributes.h.

◆ Output()

bool faudes::AttributeIosEvent::Output ( void ) const

inline

Test output flag.

Returns: true: state is an output state false: state is not an output state

Definition at line 114 of file ios_attributes.h.

◆ SetInput()

void faudes::AttributeIosEvent::SetInput ( void )

inline

Set input flag.

Note: this will clear the output flag.

Definition at line 92 of file ios_attributes.h.

◆ SetOutput()

void faudes::AttributeIosEvent::SetOutput ( void )

inline

Set output flag.

Note: this will clear the input flag.

Definition at line 72 of file ios_attributes.h.

Member Data Documentation

◆ mAllIosFlags

const fType faudes::AttributeIosEvent::mAllIosFlags =0x030

staticprotected

Definition at line 156 of file ios_attributes.h.

◆ mDefIosFlags

const fType faudes::AttributeIosEvent::mDefIosFlags =0x000

staticprotected

Definition at line 153 of file ios_attributes.h.

◆ mInputFlag

const fType faudes::AttributeIosEvent::mInputFlag =0x010

staticprotected

Definition at line 149 of file ios_attributes.h.

◆ mOutputFlag

const fType faudes::AttributeIosEvent::mOutputFlag =0x020

staticprotected

Definition at line 150 of file ios_attributes.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AttributeIosEvent() [1/2]

◆ AttributeIosEvent() [2/2]

◆ ~AttributeIosEvent()

Member Function Documentation

◆ ClrInput()

◆ ClrOutput()

◆ DoAssign()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ Input()

◆ IsDefault()

◆ Output()

◆ SetInput()

◆ SetOutput()

Member Data Documentation

◆ mAllIosFlags

◆ mDefIosFlags

◆ mInputFlag

◆ mOutputFlag