Detailed Description

Event attributes for hierarchical discrete event systems with inputs and outputs.

These Attributes are:

the input/output flag U and Y.
the flags C, P, E and L that designate membership in one or the union of more alphabets.

<>

Definition at line 32 of file hio_attributes.h.

#include <hio_attributes.h>

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

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

virtual	~HioEventFlags (void)

void	SetY (void)
	Set Y-flag. More...

void	ClrY (void)
	Clear Y-flag. More...

void	SetU (void)
	Set U-flag. More...

void	ClrU (void)
	Clear U-flag. More...

bool	IsY (void) const
	Query Y-flag. More...

bool	IsU (void) const
	Query U-flag. More...

void	SetP (void)
	Set P-flag. More...

void	ClrP (void)
	Clear P-flag. More...

bool	IsP (void) const
	Query P-flag. More...

void	SetE (void)
	Set E-flag. More...

void	ClrE (void)
	Clear E-flag. More...

bool	IsE (void) const
	Query E-flag. More...

void	SetC (void)
	Set C-flag. More...

void	ClrC (void)
	Clear C-flag. More...

bool	IsC (void) const
	Query C-flag. More...

void	SetL (void)
	Set L-flag. More...

void	ClrL (void)
	Clear L-flag. More...

bool	IsL (void) const
	Query L-flag. More...

bool	IsDefault (void) const
	Test for default value (ie input and membership in neither P-,E-,C-, nor L-alphabet) 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...

Static Public Attributes
static const fType	mUFlag =0x04

static const fType	mYFlag =0x08

static const fType	mPFlag =0x10

static const fType	mEFlag =0x20

static const fType	mCFlag =0x40

static const fType	mLFlag =0x80

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

Protected Member Functions
void	DoAssign (const HioEventFlags &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...

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

virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write to TokenWriter, see Type 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	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 Private Attributes
static const fType	mDefHioEventFlags =0x00

static const fType	mAllHioEventFlags =0xFC

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

Constructor & Destructor Documentation

◆ HioEventFlags() [1/2]

faudes::HioEventFlags::HioEventFlags ( void )

inline

Default constructor.

Definition at line 39 of file hio_attributes.h.

◆ HioEventFlags() [2/2]

faudes::HioEventFlags::HioEventFlags ( const HioEventFlags & rSrc )

inline

Copy constructor.

Definition at line 42 of file hio_attributes.h.

◆ ~HioEventFlags()

virtual faudes::HioEventFlags::~HioEventFlags ( void )

inlinevirtual

Definition at line 45 of file hio_attributes.h.

Member Function Documentation

◆ ClrC()

void faudes::HioEventFlags::ClrC ( void )

inline

Clear C-flag.

Definition at line 128 of file hio_attributes.h.

◆ ClrE()

void faudes::HioEventFlags::ClrE ( void )

inline

Clear E-flag.

Definition at line 111 of file hio_attributes.h.

◆ ClrL()

void faudes::HioEventFlags::ClrL ( void )

inline

Clear L-flag.

Definition at line 147 of file hio_attributes.h.

◆ ClrP()

void faudes::HioEventFlags::ClrP ( void )

inline

Clear P-flag.

Definition at line 93 of file hio_attributes.h.

◆ ClrU()

void faudes::HioEventFlags::ClrU ( void )

inline

Clear U-flag.

Definition at line 69 of file hio_attributes.h.

◆ ClrY()

void faudes::HioEventFlags::ClrY ( void )

inline

Clear Y-flag.

Definition at line 57 of file hio_attributes.h.

◆ DoAssign()

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

protected

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 26 of file hio_attributes.cpp.

◆ DoRead()

void faudes::HioEventFlags::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 HioEventFlag, 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 67 of file hio_attributes.cpp.

◆ DoWrite()

void faudes::HioEventFlags::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 32 of file hio_attributes.cpp.

◆ IsC()

bool faudes::HioEventFlags::IsC ( void ) const

inline

Query C-flag.

Definition at line 134 of file hio_attributes.h.

◆ IsDefault()

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

inlinevirtual

Test for default value (ie input and membership in neither P-,E-,C-, nor L-alphabet)

Reimplemented from faudes::AttributeFlags.

Definition at line 158 of file hio_attributes.h.

◆ IsE()

bool faudes::HioEventFlags::IsE ( void ) const

inline

Query E-flag.

Definition at line 117 of file hio_attributes.h.

◆ IsL()

bool faudes::HioEventFlags::IsL ( void ) const

inline

Query L-flag.

Definition at line 153 of file hio_attributes.h.

◆ IsP()

bool faudes::HioEventFlags::IsP ( void ) const

inline

Query P-flag.

Definition at line 99 of file hio_attributes.h.

◆ IsU()

bool faudes::HioEventFlags::IsU ( void ) const

inline

Query U-flag.

Definition at line 81 of file hio_attributes.h.

◆ IsY()

bool faudes::HioEventFlags::IsY ( void ) const

inline

Query Y-flag.

Definition at line 75 of file hio_attributes.h.

◆ SetC()

void faudes::HioEventFlags::SetC ( void )

inline

Set C-flag.

Definition at line 122 of file hio_attributes.h.

◆ SetE()

void faudes::HioEventFlags::SetE ( void )

inline

Set E-flag.

Definition at line 105 of file hio_attributes.h.

◆ SetL()

void faudes::HioEventFlags::SetL ( void )

inline

Set L-flag.

Definition at line 141 of file hio_attributes.h.

◆ SetP()

void faudes::HioEventFlags::SetP ( void )

inline

Set P-flag.

Definition at line 87 of file hio_attributes.h.

◆ SetU()

void faudes::HioEventFlags::SetU ( void )

inline

Set U-flag.

Definition at line 63 of file hio_attributes.h.

◆ SetY()

void faudes::HioEventFlags::SetY ( void )

inline

Set Y-flag.

Definition at line 51 of file hio_attributes.h.

Member Data Documentation

◆ mAllHioEventFlags

const fType faudes::HioEventFlags::mAllHioEventFlags =0xFC

staticprivate

Definition at line 174 of file hio_attributes.h.

◆ mCFlag

const fType faudes::HioEventFlags::mCFlag =0x40

static

Definition at line 166 of file hio_attributes.h.

◆ mDefHioEventFlags

const fType faudes::HioEventFlags::mDefHioEventFlags =0x00

staticprivate

Definition at line 171 of file hio_attributes.h.

◆ mEFlag

const fType faudes::HioEventFlags::mEFlag =0x20

static

Definition at line 165 of file hio_attributes.h.

◆ mLFlag

const fType faudes::HioEventFlags::mLFlag =0x80

static

Definition at line 167 of file hio_attributes.h.

◆ mPFlag

const fType faudes::HioEventFlags::mPFlag =0x10

static

Definition at line 164 of file hio_attributes.h.

◆ mUFlag

const fType faudes::HioEventFlags::mUFlag =0x04

static

Definition at line 162 of file hio_attributes.h.

◆ mYFlag

const fType faudes::HioEventFlags::mYFlag =0x08

static

Definition at line 163 of file hio_attributes.h.

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

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ HioEventFlags() [1/2]

◆ HioEventFlags() [2/2]

◆ ~HioEventFlags()

Member Function Documentation

◆ ClrC()

◆ ClrE()

◆ ClrL()

◆ ClrP()

◆ ClrU()

◆ ClrY()

◆ DoAssign()

◆ DoRead()

◆ DoWrite()

◆ IsC()

◆ IsDefault()

◆ IsE()

◆ IsL()

◆ IsP()

◆ IsU()

◆ IsY()

◆ SetC()

◆ SetE()

◆ SetL()

◆ SetP()

◆ SetU()

◆ SetY()

Member Data Documentation

◆ mAllHioEventFlags

◆ mCFlag

◆ mDefHioEventFlags

◆ mEFlag

◆ mLFlag

◆ mPFlag

◆ mUFlag

◆ mYFlag