Detailed Description

Globat attribute with clockset.

<>

Definition at line 220 of file tp_attributes.h.

#include <tp_attributes.h>

Public Member Functions
	AttributeTimedGlobal (void)
	Constructor. More...

virtual bool	IsDefault (void) const
	Test for default value (ie empty clockset) 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...

Public Attributes
ClockSet	mClocks
	Clocks. More...

SymbolTable *	mpClockSymbolTable
	Pointer to clock symboltable. More...

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

bool	DoEqual (const AttributeTimedGlobal &rOther) const
	Test eaulity. More...

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

virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Writes the attribute to TokenWriter, see AttributeVoid 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	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data of this object to TokenWriter in XML format. 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

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

Constructor & Destructor Documentation

◆ AttributeTimedGlobal()

faudes::AttributeTimedGlobal::AttributeTimedGlobal ( void )

inline

Constructor.

Definition at line 227 of file tp_attributes.h.

Member Function Documentation

◆ DoAssign()

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

protected

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 176 of file tp_attributes.cpp.

◆ DoEqual()

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

protected

Test eaulity.

Parameters

rOther Other attribute to compare with.

Definition at line 185 of file tp_attributes.cpp.

◆ DoRead()

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

protectedvirtual

Reads the attribute from TokenReader, see AttributeVoid for public wrappers.

If the current token indicates a Clocks section, the method reads the global timing data from that section. Else, it does nothing. Exceptions may only be thrown on invalid data within the timing section. The context argument is ignored, the label argument can be used to override the default section name Clocks.

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

Definition at line 203 of file tp_attributes.cpp.

◆ DoWrite()

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

protectedvirtual

Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.

Writes a Clocks section to include global timing data. The label argument can be used to set a section label different the the default Clocks. Th context argument is 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::AttributeVoid.

Definition at line 193 of file tp_attributes.cpp.

◆ IsDefault()

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

inlinevirtual

Test for default value (ie empty clockset)

Returns: True for default value

Reimplemented from faudes::AttributeVoid.

Definition at line 236 of file tp_attributes.h.

Member Data Documentation

◆ mClocks

ClockSet faudes::AttributeTimedGlobal::mClocks

Clocks.

Definition at line 239 of file tp_attributes.h.

◆ mpClockSymbolTable

SymbolTable* faudes::AttributeTimedGlobal::mpClockSymbolTable

Pointer to clock symboltable.

Definition at line 242 of file tp_attributes.h.

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

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AttributeTimedGlobal()

Member Function Documentation

◆ DoAssign()

◆ DoEqual()

◆ DoRead()

◆ DoWrite()

◆ IsDefault()

Member Data Documentation

◆ mClocks

◆ mpClockSymbolTable