DtPlanExecutor Class Reference

An abstract interface for the execution of a plan. More...

Inheritance diagram for DtPlanExecutor:

Public Member Functions
	DtPlanExecutor ()
virtual	~DtPlanExecutor ()
virtual bool	executeSetDataRequest (const DtPlan &plan, const DtSetDataRequest &sdr)=0
	Execute the specified Set Data Request in the context of the supplied plan.
virtual bool	executeTask (const DtPlan &plan, const DtSimTask &task)=0
	Execute the specified Task in the context of the supplied plan.
virtual bool	executeSimCommand (const DtPlan &plan, const DtSimCommand &command, DtSimCommandContextPtr &context)=0
	Execute the specified Simulation Command in the context of the supplied plan.
virtual bool	isSimCommandComplete (const DtPlan &plan, const DtSimCommand &command, const DtSimCommandContextPtr &context) const =0
	Create an executor and call it with the command context pointer to see if the command is complete.
virtual bool	evaluateConditional (const DtPlan &plan, const DtSimCondExpr *conditional)=0
	Evaluate the specified conditional.
virtual bool	taskActive (int taskId) const =0
virtual bool	stopTask (int taskId)=0
	Stops the execution of the task with the specified task execution ID.
virtual int	suspendAllTopLevelTasks ()=0
	Suspends all top level tasks and returns the suspended id.
virtual bool	resumeSuspendedTask (int)=0
	Resumes the suspended task id.
virtual bool	hasTopLevelTasks () const =0
	RFeturns true if there are tasks executing.
virtual std::vector < DtReaderWriter * >	substituteVariablesIn (const DtRwVariableBindings &, DtReaderWriter *) const =0
	Iterates over all items in the reader writer registry of the supplied item, and, if any of the variables are UUIDs and they happen to match the UUID of the simulation object or created object variable, those values in the reader/writer supplied will be set to those of the variable.
virtual std::vector < DtReaderWriter * >	substitutedValues (const DtRwVariableBindings &, const DtReaderWriter *) const =0
	Returns a vector list of reader/writer values (cloned from the source) that were substituted. The results of this call must be freed by the user.
virtual bool	subsituteUUIDIfAvailable (const DtRwVariableBindings &, const DtReaderWriter *, DtUUID &uuid) const =0
	If, in the supplied reader/writer there is a matching UUID to substitute, place the resultant value in the givem UUID and return true.

Private Member Functions
	DtPlanExecutor (const DtPlanExecutor &orig)
	Not implemented.
DtPlanExecutor &	operator= (const DtPlanExecutor &orig)
	Not implemented.

Detailed Description

An abstract interface for the execution of a plan.

This class defines the interface that is used to carry out the execution of statements and conditionals of a plan. When a subclass which implements this interface is installed in a plan, the plan can be ticked, and the methods in this interface will be called to either evaluate conditionals of the plan, or to execute various types of statements in the plan.

Constructor & Destructor Documentation

DtPlanExecutor::DtPlanExecutor ( const DtPlanExecutor &  orig )

private

Not implemented.

DtPlanExecutor::DtPlanExecutor

(

)

virtual DtPlanExecutor::~DtPlanExecutor ( )

virtual

Member Function Documentation

DtPlanExecutor& DtPlanExecutor::operator= ( const DtPlanExecutor &  orig )

private

Not implemented.

virtual bool DtPlanExecutor::executeSetDataRequest ( const DtPlan &  plan, const DtSetDataRequest &  sdr  )

pure virtual

Execute the specified Set Data Request in the context of the supplied plan.

Returns

True if successful.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::executeTask ( const DtPlan &  plan, const DtSimTask &  task  )

pure virtual

Execute the specified Task in the context of the supplied plan.

Returns

True if successful.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::executeSimCommand ( const DtPlan &  plan, const DtSimCommand &  command, DtSimCommandContextPtr &  context  )

pure virtual

Execute the specified Simulation Command in the context of the supplied plan.

Returns

True if successful. If the context is filled in, the command was successful but there is something in the context the command is not yet complete and will need to be checked to make sure it does complete

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::isSimCommandComplete ( const DtPlan &  plan, const DtSimCommand &  command, const DtSimCommandContextPtr &  context  ) const

pure virtual

Create an executor and call it with the command context pointer to see if the command is complete.

Will return true if it is

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::evaluateConditional ( const DtPlan &  plan, const DtSimCondExpr *  conditional  )

pure virtual

Evaluate the specified conditional.

Returns

True if the conditional evaluates to true.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::taskActive ( int  taskId ) const

pure virtual

Returns

True if the specified task ID is currently running. This only has meaning in the context of entity plans.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::stopTask ( int  taskId )

pure virtual

Stops the execution of the task with the specified task execution ID.

This only has meaning in the context of entity plans.

Returns

True if the task was active and stopped by this call.

Implemented in DtVrfSimPlanExecutor.

virtual int DtPlanExecutor::suspendAllTopLevelTasks ( )

pure virtual

Suspends all top level tasks and returns the suspended id.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::resumeSuspendedTask ( int  )

pure virtual

Resumes the suspended task id.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::hasTopLevelTasks ( ) const

pure virtual

RFeturns true if there are tasks executing.

Implemented in DtVrfSimPlanExecutor.

virtual std::vector<DtReaderWriter*> DtPlanExecutor::substituteVariablesIn ( const DtRwVariableBindings &  , DtReaderWriter *    ) const

pure virtual

Iterates over all items in the reader writer registry of the supplied item, and, if any of the variables are UUIDs and they happen to match the UUID of the simulation object or created object variable, those values in the reader/writer supplied will be set to those of the variable.

This call will return the values that were substituted. Do not delete the returned memory as this is the reader/writer value as it exists

Implemented in DtVrfSimPlanExecutor.

virtual std::vector<DtReaderWriter*> DtPlanExecutor::substitutedValues ( const DtRwVariableBindings &  , const DtReaderWriter *    ) const

pure virtual

Returns a vector list of reader/writer values (cloned from the source) that were substituted. The results of this call must be freed by the user.

Implemented in DtVrfSimPlanExecutor.

virtual bool DtPlanExecutor::subsituteUUIDIfAvailable ( const DtRwVariableBindings &  , const DtReaderWriter *  , DtUUID &  uuid  ) const

pure virtual

If, in the supplied reader/writer there is a matching UUID to substitute, place the resultant value in the givem UUID and return true.

Implemented in DtVrfSimPlanExecutor.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplan/planExecutor.h