Stop Class Reference

#include <Stop.h>

Inheritance diagram for Stop:

Collaboration diagram for Stop:

Public Member Functions
	Stop ()
	Exemplar constructor. More...
virtual	~Stop ()
virtual Stop *	clone (const std::string &name)
	Make clone. More...
virtual void	execute ()
	Execute the command. More...
Public Member Functions inherited from Action
virtual	~Action ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. 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...
Public Member Functions inherited from Object
virtual	~Object ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...
virtual Object *	clone (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 Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...
virtual const Attribute *	findAttribute (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 Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function. More...
virtual Object *	makeInstance (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 Object *	getBaseObject () const
	Return the object's base type object. More...
const std::string &	getOpalName () const
	Return object name. More...
Object *	getParent () 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
	Stop (const Stop &)
void	operator= (const Stop &)
	Stop (const std::string &name, Stop *parent)

Additional Inherited Members
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...
Protected Member Functions inherited from Action
	Action (int size, const char *name, const char *help)
	Constructor for exemplars. More...
	Action (const std::string &name, Action *parent)
	Constructor for cloning. 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
RCObject &	operator= (const RCObject &right)
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 24 of file Stop.h.

Constructor & Destructor Documentation

Stop() [1/3]

Stop::Stop

(

)

Exemplar constructor.

Definition at line 21 of file Stop.cpp.

Referenced by clone().

~Stop()

Stop::~Stop ( )

virtual

Definition at line 32 of file Stop.cpp.

Stop() [2/3]

Stop::Stop ( const Stop &  )

private

Stop() [3/3]

Stop::Stop ( const std::string &  name, Stop *  parent  )

private

Definition at line 27 of file Stop.cpp.

Member Function Documentation

clone()

Stop * Stop::clone ( const std::string &  name )

virtual

Make clone.

Implements Object.

Definition at line 36 of file Stop.cpp.

References name, and Stop().

Here is the call graph for this function:

execute()

void Stop::execute ( )

virtual

Execute the command.

Reimplemented from Object.

Definition at line 41 of file Stop.cpp.

operator=()

void Stop::operator= ( const Stop &  )

private

---

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

• /Users/gsell/src/OPAL/src/src/BasicActions/Stop.h
• /Users/gsell/src/OPAL/src/src/BasicActions/Stop.cpp