Detailed Description

State attributes for multitasking automata.

Definition at line 41 of file mtc_attributes.h.

#include <mtc_attributes.h>

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

virtual	~AttributeColoredState (void)

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

NameSet::Iterator	ColorsBegin () const
	Iterator for first entry in mColors. More...

NameSet::Iterator	ColorsEnd () const
	Iterator for last entry in mColors. More...

const ColorSet &	Colors (void) const
	Read access to color set. More...

ColorSet &	Colors (void)
	Writable access to color set. More...

void	Colors (const ColorSet &rColors)
	Set the color set. More...

void	ColorSymTab (SymbolTable *pSymTab)
	Set pointer to color symbol table. More...

SymbolTable *	ColorSymTabp (void) const
	Get pointer to color symbol table. 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...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. 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...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. 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...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

virtual bool	Equal (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

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
virtual void	DoAssign (const AttributeColoredState &rSrcAttr)
	Assignment method. More...

virtual bool	DoEqual (const AttributeColoredState &rOther) const
	Test equality of configuration data. More...

virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write attributes to tokenwriter. More...

virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write attributes to tokenwriter. More...

virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read attributes from tokenreader. 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

Protected Attributes
ColorSet	mColors
	Colorset. More...

SymbolTable *	mpColorSymbolTable
	Pointer to colorsymboltable. More...

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

◆ AttributeColoredState()

faudes::AttributeColoredState::AttributeColoredState ( void )

inline

Default constructor.

Definition at line 49 of file mtc_attributes.h.

◆ ~AttributeColoredState()

virtual faudes::AttributeColoredState::~AttributeColoredState ( void )

inlinevirtual

Definition at line 52 of file mtc_attributes.h.

Member Function Documentation

◆ Colors() [1/3]

void faudes::AttributeColoredState::Colors ( const ColorSet & rColors )

inline

Set the color set.

Parameters

rColors New color set

Definition at line 95 of file mtc_attributes.h.

◆ Colors() [2/3]

ColorSet& faudes::AttributeColoredState::Colors ( void )

inline

Writable access to color set.

Returns: Reference to attribute data

Definition at line 87 of file mtc_attributes.h.

◆ Colors() [3/3]

const ColorSet& faudes::AttributeColoredState::Colors ( void ) const

inline

Read access to color set.

Returns: Reference to attribute data

Definition at line 78 of file mtc_attributes.h.

◆ ColorsBegin()

NameSet::Iterator faudes::AttributeColoredState::ColorsBegin ( ) const

Iterator for first entry in mColors.

Definition at line 76 of file mtc_attributes.cpp.

◆ ColorsEnd()

NameSet::Iterator faudes::AttributeColoredState::ColorsEnd ( ) const

Iterator for last entry in mColors.

Definition at line 81 of file mtc_attributes.cpp.

◆ ColorSymTab()

void faudes::AttributeColoredState::ColorSymTab ( SymbolTable * pSymTab )

Set pointer to color symbol table.

Parameters

pSymTab New color symbol table

Definition at line 86 of file mtc_attributes.cpp.

◆ ColorSymTabp()

SymbolTable * faudes::AttributeColoredState::ColorSymTabp ( void ) const

Get pointer to color symbol table.

Returns: Pointer to current color symbol table

Definition at line 91 of file mtc_attributes.cpp.

◆ DoAssign()

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

protectedvirtual

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 35 of file mtc_attributes.cpp.

◆ DoEqual()

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

protectedvirtual

Test equality of configuration data.

Parameters

rOther Other attribute to compare with.

Returns: True on match.

Definition at line 43 of file mtc_attributes.cpp.

◆ DoRead()

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

protectedvirtual

Read attributes from tokenreader.

Parameters

rTr	Tokenreader to read from
rLabel	Section to read
pContext	Read context to provide contextual information

Exceptions

Exception Thrown on file format errors (ids 50, 51)

Reimplemented from faudes::AttributeFlags.

Definition at line 66 of file mtc_attributes.cpp.

◆ DoWrite()

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

protectedvirtual

Write attributes to tokenwriter.

Parameters

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

Exceptions

Exception I/O errors

Reimplemented from faudes::AttributeFlags.

Definition at line 55 of file mtc_attributes.cpp.

◆ DoXWrite()

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

protectedvirtual

Write attributes to tokenwriter.

Parameters

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

Exceptions

Exception I/O errors

Reimplemented from faudes::AttributeFlags.

Definition at line 60 of file mtc_attributes.cpp.

◆ IsDefault()

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

inlinevirtual

Test for default value.

Returns: True for defaultvalue

Reimplemented from faudes::AttributeFlags.

Definition at line 60 of file mtc_attributes.h.

Member Data Documentation

◆ mColors

ColorSet faudes::AttributeColoredState::mColors

protected

Colorset.

Definition at line 116 of file mtc_attributes.h.

◆ mpColorSymbolTable

SymbolTable* faudes::AttributeColoredState::mpColorSymbolTable

protected

Pointer to colorsymboltable.

Definition at line 119 of file mtc_attributes.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AttributeColoredState()

◆ ~AttributeColoredState()

Member Function Documentation

◆ Colors() [1/3]

◆ Colors() [2/3]

◆ Colors() [3/3]

◆ ColorsBegin()

◆ ColorsEnd()

◆ ColorSymTab()

◆ ColorSymTabp()

◆ DoAssign()

◆ DoEqual()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ IsDefault()

Member Data Documentation

◆ mColors

◆ mpColorSymbolTable