Detailed Description

Attribute class to model event controllability properties.

This attribute is meant to be an event attribute and can distinguish between controllable, observable, forcible and abstraction events. It is based on faudes::AttributeFlags and uses the lower four bits in the flag word to store the respective boolean values. The AttributeCFlags class adds convenience functions to access these bits and a default-value that corresponds to observable and neiter controllable nor forcible.

Presuming that only controllability flags are uses (different from default), the token representation is by an Option String consisting of the initials c,o,f and a, where initials are capitatised for set flags and default values are not written; eg +C+ for a controllable event that is observable (default), not forcible (default) and
an abstraction event (default). If other than the four controllability bits are used, std. hex format is used.

Definition at line 217 of file cfl_attributes.h.

#include <cfl_attributes.h>

Public Member Functions
	AttributeCFlags (void)

virtual	~AttributeCFlags (void)

void	SetControllable (void)

void	ClrControllable (void)

bool	Controllable (void) const

void	SetObservable (void)

void	ClrObservable (void)

bool	Observable (void) const

void	SetForcible (void)

void	ClrForcible (void)

bool	Forcible (void) const

void	SetHighlevel (void)

void	SetLowlevel (void)

bool	Highlevel (void) const

bool	Lowlevel (void) const

virtual bool	IsDefault (void) const

Public Member Functions inherited from faudes::AttributeFlags
	AttributeFlags (void)

	AttributeFlags (const AttributeFlags &rOther)

virtual	~AttributeFlags (void)

bool	Test (fType mask) const

bool	TestAll (fType mask) const

bool	TestSome (fType mask) const

bool	TestNone (fType mask) const

void	Set (fType mask)

void	Clr (fType mask)

Public Member Functions inherited from faudes::AttrType
	AttrType (void)

	AttrType (const AttrType &rSrc)

virtual	~AttrType (void)

Type &	operator= (const Type &rSrc)

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

Public Member Functions inherited from faudes::Type
	Type (void)

	Type (const Type &rType)

virtual	~Type (void)

virtual Type *	New (void) const

virtual Type *	Copy (void) const

virtual const Type *	Cast (const Type *pOther) const

virtual void	Clear (void)

virtual Type &	Assign (const Type &rSrc)

Type &	operator= (const Type &rSrc)

virtual bool	Equal (const Type &rOther) const

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

virtual void	Name (const std::string &rName)

virtual const std::string &	Name (void) const

virtual const std::string &	TypeName (void) const

void	Write (const Type *pContext=0) const

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

void	Write (const std::string &pFileName, std::ios::openmode openmode) const

void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const

void	XWrite (const Type *pContext=0) const

void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const

std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const

void	DWrite (const Type *pContext=0) const

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

void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

void	SWrite (TokenWriter &rTw) const

void	SWrite (void) const

std::string	ToSText (void) const

void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)

void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)

void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Static Public Attributes
static const fType	mControllableFlag =0x01

static const fType	mObservableFlag =0x02

static const fType	mForcibleFlag =0x04

static const fType	mAbstractionFlag =0x08

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

Protected Member Functions
void	DoAssign (const AttributeCFlags &rSrcAttr)

bool	DoEqual (const AttributeCFlags &rOther) const

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

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

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

Protected Member Functions inherited from faudes::AttributeFlags
void	DoAssign (const AttributeFlags &rSrcAttr)

bool	DoEqual (const AttributeFlags &rOther) const

Protected Member Functions inherited from faudes::AttrType
void	DoAssign (const AttrType &rSrc)

bool	DoEqual (const AttrType &rOther) const

Protected Member Functions inherited from faudes::Type
void	DoAssign (const Type &rSrc)

bool	DoEqual (const Type &rOther) const

virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoSWrite (TokenWriter &rTw) const

virtual const TypeDefinition *	TypeDefinitionp (void) const

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

Static Private Attributes
static const fType	mDefCFlags =0x0a

static const fType	mAllCFlags =0x0f

Additional Inherited Members
Static Public Member Functions inherited from faudes::AttrType
static void	Skip (TokenReader &rTr)

Public Attributes inherited from faudes::AttributeFlags
fType	mFlags

Constructor & Destructor Documentation

◆ AttributeCFlags()

faudes::AttributeCFlags::AttributeCFlags ( void )

inline

Default constructor

Definition at line 230 of file cfl_attributes.h.

◆ ~AttributeCFlags()

virtual faudes::AttributeCFlags::~AttributeCFlags ( void )

inlinevirtual

Destructor

Definition at line 233 of file cfl_attributes.h.

Member Function Documentation

◆ ClrControllable()

void faudes::AttributeCFlags::ClrControllable ( void )

inline

Clear controllable flag

Definition at line 244 of file cfl_attributes.h.

◆ ClrForcible()

void faudes::AttributeCFlags::ClrForcible ( void )

inline

Clear forcible flag

Definition at line 277 of file cfl_attributes.h.

◆ ClrObservable()

void faudes::AttributeCFlags::ClrObservable ( void )

inline

Clear observable flag

Definition at line 260 of file cfl_attributes.h.

◆ Controllable()

bool faudes::AttributeCFlags::Controllable ( void ) const

inline

Query controllablility

Definition at line 249 of file cfl_attributes.h.

◆ DoAssign()

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

protected

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 116 of file cfl_attributes.cpp.

◆ DoEqual()

bool faudes::AttributeCFlags::DoEqual ( const AttributeCFlags & rOther ) const

protected

Test equality of configuration data.

Parameters

rOther Other attribute to compare with.

Returns: True on match.

Definition at line 122 of file cfl_attributes.cpp.

◆ DoRead()

void faudes::AttributeCFlags::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 AttributeCFlag, 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.

Reimplemented in faudes::AttributePriority, and faudes::SimEventAttribute.

Definition at line 204 of file cfl_attributes.cpp.

◆ DoWrite()

void faudes::AttributeCFlags::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.

Reimplemented in faudes::AttributePriority, and faudes::SimEventAttribute.

Definition at line 133 of file cfl_attributes.cpp.

◆ DoXWrite()

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

protectedvirtual

Writes attribute to TokenWriter (XML format), 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.

Reimplemented in faudes::AttributePriority.

Definition at line 170 of file cfl_attributes.cpp.

◆ Forcible()

bool faudes::AttributeCFlags::Forcible ( void ) const

inline

Query forcibility

Definition at line 282 of file cfl_attributes.h.

◆ Highlevel()

bool faudes::AttributeCFlags::Highlevel ( void ) const

inline

Query abstaction flag

Definition at line 298 of file cfl_attributes.h.

◆ IsDefault()

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

inlinevirtual

Test for default value

Reimplemented from faudes::AttributeFlags.

Reimplemented in faudes::SimEventAttribute, and faudes::AttributePriority.

Definition at line 309 of file cfl_attributes.h.

◆ Lowlevel()

bool faudes::AttributeCFlags::Lowlevel ( void ) const

inline

Query abstaction flag

Definition at line 303 of file cfl_attributes.h.

◆ Observable()

bool faudes::AttributeCFlags::Observable ( void ) const

inline

Query observablility

Definition at line 265 of file cfl_attributes.h.

◆ SetControllable()

void faudes::AttributeCFlags::SetControllable ( void )

inline

Set controllable flag

Definition at line 238 of file cfl_attributes.h.

◆ SetForcible()

void faudes::AttributeCFlags::SetForcible ( void )

inline

Set forcible flag

Definition at line 271 of file cfl_attributes.h.

◆ SetHighlevel()

void faudes::AttributeCFlags::SetHighlevel ( void )

inline

Set abstraction flag

Definition at line 288 of file cfl_attributes.h.

◆ SetLowlevel()

void faudes::AttributeCFlags::SetLowlevel ( void )

inline

Clear abstraction flag

Definition at line 293 of file cfl_attributes.h.

◆ SetObservable()

void faudes::AttributeCFlags::SetObservable ( void )

inline

Set observable flag

Definition at line 255 of file cfl_attributes.h.

Member Data Documentation

◆ mAbstractionFlag

const fType faudes::AttributeCFlags::mAbstractionFlag =0x08

static

Definition at line 315 of file cfl_attributes.h.

◆ mAllCFlags

const fType faudes::AttributeCFlags::mAllCFlags =0x0f

staticprivate

All flags used by CFlags

Definition at line 322 of file cfl_attributes.h.

◆ mControllableFlag

const fType faudes::AttributeCFlags::mControllableFlag =0x01

static

Definition at line 312 of file cfl_attributes.h.

◆ mDefCFlags

const fType faudes::AttributeCFlags::mDefCFlags =0x0a

staticprivate

Overall default value

Definition at line 319 of file cfl_attributes.h.

◆ mForcibleFlag

const fType faudes::AttributeCFlags::mForcibleFlag =0x04

static

Definition at line 314 of file cfl_attributes.h.

◆ mObservableFlag

const fType faudes::AttributeCFlags::mObservableFlag =0x02

static

Definition at line 313 of file cfl_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

◆ AttributeCFlags()

◆ ~AttributeCFlags()

Member Function Documentation

◆ ClrControllable()

◆ ClrForcible()

◆ ClrObservable()

◆ Controllable()

◆ DoAssign()

◆ DoEqual()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ Forcible()

◆ Highlevel()

◆ IsDefault()

◆ Lowlevel()

◆ Observable()

◆ SetControllable()

◆ SetForcible()

◆ SetHighlevel()

◆ SetLowlevel()

◆ SetObservable()

Member Data Documentation

◆ mAbstractionFlag

◆ mAllCFlags

◆ mControllableFlag

◆ mDefCFlags

◆ mForcibleFlag

◆ mObservableFlag