faudes::HioStateFlags Class Reference
[Hierarchical I/O Systems PlugIn]

State attributes for hierarchical discrete event systems with inputs and outputs. More...

#include <hio_attributes.h>

Public Member Functions
	HioStateFlags (void)
	Default constructor.
	HioStateFlags (const HioStateFlags &rSrc)
	Copy constructor.
virtual	~HioStateFlags (void)
virtual std::string	ToString (void) const
	Write attribute to string.
void	SetQY (void)
	Set QY-state flag.
void	ClrQY (void)
	Clear QY-state flag.
bool	IsQY (void) const
	Query QY-state flag.
void	SetQU (void)
	Set QU-state flag.
void	ClrQU (void)
	Clear QU-state flag.
bool	IsQU (void) const
	Query QU-state flag.
void	SetQC (void)
	Set QC-state flag.
void	ClrQC (void)
	Clear QC-state flag.
bool	IsQC (void) const
	Query QC-state flag.
void	SetQP (void)
	Set QP-state flag.
void	ClrQP (void)
	Clear QP-state flag.
bool	IsQP (void) const
	Query QP-state flag.
void	SetQE (void)
	Set QE-state flag.
void	ClrQE (void)
	Clear QE-state flag.
bool	IsQE (void) const
	Query QE-state flag.
void	SetQL (void)
	Set QL-state flag.
void	ClrQL (void)
	Clear QL-state flag.
bool	IsQL (void) const
	Query QL-state flag.
void	SetQYcUp (void)
	Set QYcUp-state flag.
void	ClrQYcUp (void)
	Clear QYcUp-state flag.
bool	IsQYcUp (void) const
	Query QYcUp-state flag.
void	SetQYlUe (void)
	Set QYlUe-state flag.
void	ClrQYlUe (void)
	Clear QYlUe-state flag.
bool	IsQYlUe (void) const
	Query QYlUe-state flag.
void	SetErr (void)
	Set Err-state flag.
void	ClrErr (void)
	Clear Err-state flag.
bool	IsErr (void) const
	Query Err-state flag.
bool	IsDefault (void) const
	Test for default value.
Static Public Attributes
static const fType	mQYFlag = 0x01
static const fType	mQUFlag = 0x02
static const fType	mQCFlag = 0x04
static const fType	mQPFlag = 0x08
static const fType	mQEFlag = 0x10
static const fType	mQLFlag = 0x20
static const fType	mQYcUpFlag = 0x40
static const fType	mQYlUeFlag = 0x80
static const fType	mErrFlag = 0x100
Protected Member Functions
void	DoAssign (const HioStateFlags &rSrcAttr)
	Assignment method.
virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Reads attribute from TokenReader, see AttributeVoid for public wrappers.
virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Writes attribute to TokenWriter, see AttributeVoid for public wrappers.
Static Private Attributes
static const fType	mDefHioStateFlags = 0x000
static const fType	mAllHioStateFlags = 0x1FF

Detailed Description

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

The flags are used by eg assertion functions to describe membership of the active events of a given state in a certain alphabet:

QY: only output (Y-) events are active.
QU: only input (U-) events are active.
additional flags QC,QP,QE,QL can be set/cleared to designate membership of the active events in the C-,P-,E-,L-alphabet, respectively. Membership in the union of several alphabets is possible by setting more than one of these flags.
states with active input- as well as active output-events are provided with the exclusive flags QYcUp, meaning that only events of the alphabet YC or UP are active, and QYlUe, meaning that only events of the alphabet YL or UE are active. QY,QU,QYcUp and QYlUe are exclusive by construction of the Set() operations.
Err: with public read/write access in all hiogenerators, this flag enables to specify so-called "Error behaviour" that is typically entered after unexpected input events, for example malfunction of a HioPlant after faulty operator input. The flag can be used by the model designer; also the hio function FreeInput() uses this flag when extending a hio generator by error behaviour in order to make an input free in this generator. Err is not bound to any formal definition and does not effect / can be combined with any of the remaining flags. Hence, Err remains untouched by the functions IsIoPlant(), IsIoController(), IsIoEnvironment(), IsIoConstraint() and UpdateStateAttributes().

Definition at line 256 of file hio_attributes.h.

Constructor & Destructor Documentation

faudes::HioStateFlags::HioStateFlags ( void ) [inline]

Default constructor.

Definition at line 265 of file hio_attributes.h.

faudes::HioStateFlags::HioStateFlags ( const HioStateFlags & rSrc ) [inline]

Copy constructor.

Definition at line 268 of file hio_attributes.h.

virtual faudes::HioStateFlags::~HioStateFlags ( void ) [inline, virtual]

Definition at line 271 of file hio_attributes.h.

Member Function Documentation

void faudes::HioStateFlags::ClrErr ( void ) [inline]

Clear Err-state flag.

Definition at line 457 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQC ( void ) [inline]

Clear QC-state flag.

Definition at line 339 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQE ( void ) [inline]

Clear QE-state flag.

Definition at line 375 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQL ( void ) [inline]

Clear QL-state flag.

Definition at line 393 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQP ( void ) [inline]

Clear QP-state flag.

Definition at line 357 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQU ( void ) [inline]

Clear QU-state flag.

Definition at line 321 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQY ( void ) [inline]

Clear QY-state flag.

Definition at line 298 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQYcUp ( void ) [inline]

Clear QYcUp-state flag.

Definition at line 416 of file hio_attributes.h.

void faudes::HioStateFlags::ClrQYlUe ( void ) [inline]

Clear QYlUe-state flag.

Definition at line 439 of file hio_attributes.h.

void faudes::HioStateFlags::DoAssign ( const HioStateFlags & rSrcAttr ) [protected]

Assignment method.

Parameters:

rSrcAttr

Source to assign from

Definition at line 121 of file hio_attributes.cpp.

void faudes::HioStateFlags::DoRead	(	TokenReader &	rTr,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)			`[protected, virtual]`

Reads attribute from TokenReader, see AttributeVoid for public wrappers.

Reads a single token if it can be interpreted as HioStateFlag, 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 171 of file hio_attributes.cpp.

void faudes::HioStateFlags::DoWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)			const `[protected, virtual]`

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 127 of file hio_attributes.cpp.

bool faudes::HioStateFlags::IsDefault ( void ) const [inline, virtual]

Test for default value.

Reimplemented from faudes::AttributeFlags.

Definition at line 468 of file hio_attributes.h.

bool faudes::HioStateFlags::IsErr ( void ) const [inline]

Query Err-state flag.

Definition at line 463 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQC ( void ) const [inline]

Query QC-state flag.

Definition at line 345 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQE ( void ) const [inline]

Query QE-state flag.

Definition at line 381 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQL ( void ) const [inline]

Query QL-state flag.

Definition at line 399 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQP ( void ) const [inline]

Query QP-state flag.

Definition at line 363 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQU ( void ) const [inline]

Query QU-state flag.

Definition at line 327 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQY ( void ) const [inline]

Query QY-state flag.

Definition at line 304 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQYcUp ( void ) const [inline]

Query QYcUp-state flag.

Definition at line 422 of file hio_attributes.h.

bool faudes::HioStateFlags::IsQYlUe ( void ) const [inline]

Query QYlUe-state flag.

Definition at line 445 of file hio_attributes.h.

void faudes::HioStateFlags::SetErr ( void ) [inline]

Set Err-state flag.

Definition at line 451 of file hio_attributes.h.

void faudes::HioStateFlags::SetQC ( void ) [inline]

Set QC-state flag.

Definition at line 333 of file hio_attributes.h.

void faudes::HioStateFlags::SetQE ( void ) [inline]

Set QE-state flag.

Definition at line 369 of file hio_attributes.h.

void faudes::HioStateFlags::SetQL ( void ) [inline]

Set QL-state flag.

Definition at line 387 of file hio_attributes.h.

void faudes::HioStateFlags::SetQP ( void ) [inline]

Set QP-state flag.

Definition at line 351 of file hio_attributes.h.

void faudes::HioStateFlags::SetQU ( void ) [inline]

Set QU-state flag.

Definition at line 310 of file hio_attributes.h.

void faudes::HioStateFlags::SetQY ( void ) [inline]

Set QY-state flag.

Definition at line 287 of file hio_attributes.h.

void faudes::HioStateFlags::SetQYcUp ( void ) [inline]

Set QYcUp-state flag.

Definition at line 405 of file hio_attributes.h.

void faudes::HioStateFlags::SetQYlUe ( void ) [inline]

Set QYlUe-state flag.

Definition at line 428 of file hio_attributes.h.

std::string faudes::HioStateFlags::ToString ( void ) const [virtual]

Write attribute to string.

Returns:: string representation of attributes

Definition at line 166 of file hio_attributes.cpp.

Member Data Documentation

const fType faudes::HioStateFlags::mAllHioStateFlags = 0x1FF [static, private]

Definition at line 487 of file hio_attributes.h.

const fType faudes::HioStateFlags::mDefHioStateFlags = 0x000 [static, private]

Definition at line 484 of file hio_attributes.h.

const fType faudes::HioStateFlags::mErrFlag = 0x100 [static]

Definition at line 480 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQCFlag = 0x04 [static]

Definition at line 474 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQEFlag = 0x10 [static]

Definition at line 476 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQLFlag = 0x20 [static]

Definition at line 477 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQPFlag = 0x08 [static]

Definition at line 475 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQUFlag = 0x02 [static]

Definition at line 473 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQYcUpFlag = 0x40 [static]

Definition at line 478 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQYFlag = 0x01 [static]

Definition at line 472 of file hio_attributes.h.

const fType faudes::HioStateFlags::mQYlUeFlag = 0x80 [static]

Definition at line 479 of file hio_attributes.h.

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

faudes::HioStateFlags Class Reference [Hierarchical I/O Systems PlugIn]

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

faudes::HioStateFlags Class Reference
[Hierarchical I/O Systems PlugIn]