VR-Forces 4.0.4 Class Documentation
Public Member Functions | Private Member Functions
DtPlanExecutor Class Reference

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

Inheritance diagram for DtPlanExecutor:
Inheritance graph
[legend]

List of all members.

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)=0
 Execute the specified Simulation Command in the context of the supplied plan.
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.

Private Member Functions

 DtPlanExecutor (const DtPlanExecutor &orig)
 Not implemented.
DtPlanExecutoroperator= (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.

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, and DtGlobalPlanExecutor.

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, and DtGlobalPlanExecutor.

virtual bool DtPlanExecutor::executeSimCommand ( const DtPlan plan,
const DtSimCommand command 
) [pure virtual]

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

Returns:
True if successful.

Implemented in DtVrfSimPlanExecutor, and DtGlobalPlanExecutor.

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, and DtGlobalPlanExecutor.

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, and DtGlobalPlanExecutor.

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, and DtGlobalPlanExecutor.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)