Global attribute with stack alphabet and stack bottom. More...

#include <pd_attributes.h>

Public Member Functions

 AttributePushdownGlobal (void)
 Constructor.
virtual bool IsDefault (void) const
 Test for default value (no stack symbols)
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 Constructor.
virtual ~AttributeVoid (void)
 Destructor.
virtual void SetDefault (void)
 Set to default value.
virtual void Clear (void)
 Synonym for SetDefault to match std interface.
- Public Member Functions inherited from faudes::Type
 Type (void)
 Constructor.
 Type (const Type &rType)
 Copy constructor.
virtual ~Type (void)
 Destructor.
virtual TypeNew (void) const
 Construct on heap.
virtual TypeCopy (void) const
 Construct on heap.
virtual const TypeCast (const Type *pOther) const
 Cast other object to this type.
virtual TypeAssign (const Type &rSrc)
 Assign configuration data from other object.
virtual Typeoperator= (const Type &rSrc)
 Assign configurationdata from other object.
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data.
virtual bool operator== (const Type &rOther) const
 Test equality of configuration data.
virtual bool operator!= (const Type &rOther) const
 Test equality of configuration data.
virtual void Name (const std::string &rName)
 Set the objects's name.
virtual const std::string & Name (void) const
 Get objects's name.
void Write (const Type *pContext=0) const
 Write configuration data to console.
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.
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 Write configuration data to a file.
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to TokenWriter.
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to an XML file.
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.
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in XML format to TokenWriter.
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a string.
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a formated string.
void DWrite (const Type *pContext=0) const
 Write configuration data to console, debugging format.
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.
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in debug format to TokenWriter.
void SWrite (TokenWriter &rTw) const
 Write statistics comment to TokenWriter.
void SWrite (void) const
 Write statistics comment to console.
std::string ToSText (void) const
 Write statistics to a string.
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from file with label specified.
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from a string.
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from TokenReader with label sepcified.

Public Attributes

StackSymbolSet mStackSymbols
 Stack Symbols.
Idx mStackBottom
SymbolTablempStackSymbolTable
 Pointer to stack symbol table.

Protected Member Functions

void DoAssign (const AttributePushdownGlobal &rSrcAttr)
 Assignment method.
bool DoEqual (const AttributePushdownGlobal &rOther) const
 Test equality.
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Reads the attribute from TokenReader, see AttributeVoid for public wrappers.
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.
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.
- Protected Member Functions inherited from faudes::AttributeVoid
virtual void DoAssign (const AttributeVoid &rSrcAttr)
 Assign attribute members.
virtual bool DoEqual (const AttributeVoid &rOther) const
 Test equality of configuration data.
- Protected Member Functions inherited from faudes::Type
virtual void DoAssign (const Type &rSrc)
 Assign configuration data from other object.
virtual bool DoEqual (const Type &rOther) const
 Test equality of configuration data.
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in debugging format to TokenWriter.
virtual void DoSWrite (TokenWriter &rTw) const
 Write statistical data as a comment to TokenWriter.
virtual const TypeDefinitionTypeDefinitionp (void) const
 Get objects's type definition.
virtual const std::string & TypeName (void) const
 Get objects's type name.
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.

Detailed Description

Global attribute with stack alphabet and stack bottom.

Definition at line 279 of file pd_attributes.h.

Constructor & Destructor Documentation

faudes::AttributePushdownGlobal::AttributePushdownGlobal ( void  )
inline

Constructor.

Definition at line 286 of file pd_attributes.h.

Member Function Documentation

void faudes::AttributePushdownGlobal::DoAssign ( const AttributePushdownGlobal rSrcAttr)
protected

Assignment method.

Parameters
rSrcAttrSource to assign from

Definition at line 350 of file pd_attributes.cpp.

bool faudes::AttributePushdownGlobal::DoEqual ( const AttributePushdownGlobal rOther) const
protected

Test equality.

Parameters
rOtherOther attribute to compare with.

Definition at line 360 of file pd_attributes.cpp.

void faudes::AttributePushdownGlobal::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
rTrTokenReader to read from
rLabelSection to read
pContextRead context to provide contextual information
Exceptions
Exception
  • IO error (id 1)

Reimplemented from faudes::AttributeVoid.

Definition at line 386 of file pd_attributes.cpp.

void faudes::AttributePushdownGlobal::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
rTwTokenWriter to write to
rLabelSection to write
pContextWrite context to provide contextual information
Exceptions
Exception
  • IO error (id 2)

Reimplemented from faudes::AttributeVoid.

Definition at line 368 of file pd_attributes.cpp.

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

Write configuration data of this object to TokenWriter in XML format.

Reimplement this method in derived classes to provide the XML token io interface defined in the public section of Type. The default implementation invokes the std token output via DoWrite(TokenWriter&, const std::string&,const Type* )

Parameters
rTwReference to TokenWriter
rLabelLabel of section to write
pContextWrite context to provide contextual information
Exceptions
Exception
  • IO errors (id 2)

Reimplemented from faudes::Type.

Definition at line 361 of file pd_attributes.h.

virtual bool faudes::AttributePushdownGlobal::IsDefault ( void  ) const
inlinevirtual

Test for default value (no stack symbols)

Returns
True for default value

Reimplemented from faudes::AttributeVoid.

Definition at line 295 of file pd_attributes.h.

Member Data Documentation

SymbolTable* faudes::AttributePushdownGlobal::mpStackSymbolTable

Pointer to stack symbol table.

Definition at line 302 of file pd_attributes.h.

Idx faudes::AttributePushdownGlobal::mStackBottom

Definition at line 299 of file pd_attributes.h.

StackSymbolSet faudes::AttributePushdownGlobal::mStackSymbols

Stack Symbols.

Definition at line 295 of file pd_attributes.h.


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

libFAUDES 2.26g --- 2015.08.17 --- c++ api documentaion by doxygen