OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
LineTemplate Class Reference

#include <LineTemplate.h>

Inheritance diagram for LineTemplate:
Inheritance graph
[legend]
Collaboration diagram for LineTemplate:
Collaboration graph
[legend]

Public Member Functions

 LineTemplate ()
 
virtual ~LineTemplate ()
 
virtual LineTemplateclone (const std::string &name)
 Make clone. More...
 
virtual ObjectmakeInstance (const std::string &name, Statement &stat, const Parser *)
 Make line instance. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Make a line template. More...
 
void parseTemplate (TokenStream &is, Statement &stat)
 Parse the line template. More...
 
- Public Member Functions inherited from Macro
 Macro (int size, const char *name, const char *help)
 Exemplar constructor. More...
 
 Macro (const std::string &name, Object *parent)
 Clone constructor. More...
 
virtual ~Macro ()
 
virtual Macroclone (const std::string &name)
 Make clone. More...
 
virtual const std::string getCategory () const
 Return the object category as a string. More...
 
virtual bool shouldTrace () const
 Trace flag. More...
 
virtual bool shouldUpdate () const
 Update flag. More...
 
virtual void parseActuals (Statement &)
 Parse actual arguments. More...
 
virtual void parseFormals (Statement &)
 Parse formal arguments. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual Objectclone (const std::string &name)=0
 Return a clone. More...
 
void copyAttributes (const Object &)
 Copy attributes from another object. More...
 
virtual void execute ()
 Execute the command. More...
 
virtual AttributefindAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const AttributefindAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual const std::string getCategory () const =0
 Return the object category as a string. More...
 
virtual bool shouldTrace () const =0
 Trace flag. More...
 
virtual bool shouldUpdate () const =0
 Update flag. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual ObjectmakeInstance (const std::string &name, Statement &, const Parser *)
 Macro handler function. More...
 
virtual void parse (Statement &)
 Parse the object. More...
 
virtual void parseShortcut (Statement &, bool eval=true)
 Parser for single-attribute commands. More...
 
virtual void print (std::ostream &) const
 Print the object. More...
 
virtual void printValue (std::ostream &) const
 
virtual void printHelp (std::ostream &) const
 Print help. More...
 
virtual void replace (Object *oldObject, Object *newObject)
 Replace references. More...
 
virtual void update ()
 Update this object. More...
 
bool isBuiltin () const
 True, if [b]this[/b] is a built-in object. More...
 
virtual bool isShared () const
 Shared flag. More...
 
virtual void setShared (bool)
 Set/reset shared flag. More...
 
void setDirty (bool)
 Set/reset the [b]modified[/b] flag. More...
 
bool isDirty () const
 True, if the [b]modified[/b] flag is set. More...
 
void setFlag (bool)
 Flag/unflag this object, e. g. to control output of objects for. More...
 
bool isFlagged () const
 True, if [b]this[/b] is flagged by setFlag(true). More...
 
const ObjectgetBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
ObjectgetParent () const
 Return parent pointer. More...
 
bool isTreeMember (const Object *subTree) const
 Test for tree membership. More...
 
void setOpalName (const std::string &name)
 Set object name. More...
 
void setParent (Object *)
 Set parent object. More...
 
void clear ()
 Clear the occurrence counter. More...
 
int increment ()
 Increment and return the occurrence counter. More...
 
int occurrenceCount ()
 Return the occurrence counter. More...
 
void registerReference (Invalidator *a)
 Register a reference to this object. More...
 
void unregisterReference (Invalidator *a)
 Unegister a reference to this object. More...
 
void registerOwnership (const AttributeHandler::OwnerType &itsClass) const
 
- Public Member Functions inherited from RCObject
int addReference () const
 Increment reference count. More...
 
int removeReference () const
 Decrement the reference count. More...
 
bool isShared () const
 Test for sharing. More...
 

Private Member Functions

 LineTemplate (const LineTemplate &)
 
void operator= (const LineTemplate &)
 
 LineTemplate (const std::string &name, Object *parent)
 

Private Attributes

MacroStream body
 

Friends

class Line
 

Additional Inherited Members

- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes. More...
 
- Protected Member Functions inherited from Object
 Object (int size, const char *name, const char *help)
 Constructor for exemplars. More...
 
 Object (const std::string &name, Object *parent)
 Constructor for clones. More...
 
- Protected Member Functions inherited from RCObject
 RCObject ()
 Default constructor. More...
 
 RCObject (const RCObject &)
 Copy constructor. More...
 
virtual ~RCObject ()=0
 
RCObjectoperator= (const RCObject &right)
 
- Protected Attributes inherited from Macro
std::vector< std::string > formals
 The formal argument list. More...
 
std::vector< std::vector< Token > > actuals
 The actual argument list. More...
 
- Protected Attributes inherited from Object
bool builtin
 Built-in flag. More...
 
bool modified
 Dirty flag. More...
 
bool flagged
 Object flag. More...
 

Detailed Description

Definition at line 34 of file LineTemplate.h.

Constructor & Destructor Documentation

◆ LineTemplate() [1/3]

LineTemplate::LineTemplate ( )

Definition at line 34 of file LineTemplate.cpp.

◆ ~LineTemplate()

LineTemplate::~LineTemplate ( )
virtual

Definition at line 47 of file LineTemplate.cpp.

◆ LineTemplate() [2/3]

LineTemplate::LineTemplate ( const LineTemplate )
private

◆ LineTemplate() [3/3]

LineTemplate::LineTemplate ( const std::string &  name,
Object parent 
)
private

Definition at line 42 of file LineTemplate.cpp.

Member Function Documentation

◆ clone()

LineTemplate * LineTemplate::clone ( const std::string &  name)
virtual

Make clone.

Reimplemented from Macro.

Definition at line 51 of file LineTemplate.cpp.

◆ makeInstance()

Object * LineTemplate::makeInstance ( const std::string &  name,
Statement stat,
const Parser  
)
virtual

◆ makeTemplate()

Object * LineTemplate::makeTemplate ( const std::string &  ,
TokenStream ,
Statement  
)
virtual

Make a line template.

Reimplemented from Object.

Definition at line 109 of file LineTemplate.cpp.

◆ operator=()

void LineTemplate::operator= ( const LineTemplate )
private

◆ parseTemplate()

void LineTemplate::parseTemplate ( TokenStream is,
Statement stat 
)

Parse the line template.

Definition at line 115 of file LineTemplate.cpp.

References MacroStream::append(), Statement::atEnd(), body, Statement::getCurrent(), Token::isDel(), Statement::keyword(), Macro::parseFormals(), and PAssert.

Referenced by Line::makeTemplate().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Line

friend class Line
friend

Definition at line 36 of file LineTemplate.h.

Member Data Documentation

◆ body

MacroStream LineTemplate::body
private

Definition at line 71 of file LineTemplate.h.

Referenced by makeInstance(), and parseTemplate().


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