DtSimCommandExecutor Class Reference

Abstract base class for all simCommand executors. More...

Inheritance diagram for DtSimCommandExecutor:

Public Member Functions
	DtSimCommandExecutor (DtSimManager *simManager)
virtual	~DtSimCommandExecutor ()
virtual bool	executeAndDistribute (const DtSimCommand *command, const DtPlan *plan=0)
	Executes and then distributes the sim command by calling the execute and distribute functions in turn.
virtual bool	executeAndDistribute (const DtSimCommand *command, const DtUUID &objectName, const DtPlan *plan=0)
	Executes and then distributes the sim command in the context of a specific entity by calling the execute and distribute functions in turn.

Static Public Member Functions
static void	setFactory (DtSimCommandExecutorFactory *factory)
	Sets the static factory member.
static DtSimCommandExecutor *	createSimCommandExecutor (const DtSimCommandMessageType &type, DtSimManager *simManager)
	Uses the static factory member to create a new executor of the specified type.

Protected Member Functions
virtual bool	execute (const DtSimCommand *command, const DtPlan *plan=0)=0
	Perform the actual execution of the DtSimCommand.
virtual bool	execute (const DtSimCommand *command, const DtUUID &objectName, const DtPlan *plan=0)
	Performs the actual executor of the DtSimCommand in the context of a specific entity.
virtual void	distribute (const DtSimCommand *command, const DtPlan *plan=0)
	Calls on the sim command distributor to distribute the command to registered callback functions.
virtual void	distribute (const DtSimCommand *command, const DtUUID &objectName, const DtPlan *plan=0)
	Calls on the sim command distributor to distribute the command to registered callback functions, providing the context of a specific entity.

Protected Attributes
DtSimManager *	mySimManager

Static Protected Attributes
static DtSimCommandExecutorFactory *	myFactory

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

Detailed Description

Abstract base class for all simCommand executors.

Every DtSimCommand should have a corresponding DtSimCommandExecutor subclass that implements the execution of that command.

Examples

• Add Simulation Command Example

Constructor & Destructor Documentation

DtSimCommandExecutor::DtSimCommandExecutor

(

DtSimManager *

simManager

)

virtual DtSimCommandExecutor::~DtSimCommandExecutor ( )

virtual

DtSimCommandExecutor::DtSimCommandExecutor ( )

private

Not implemented.

DtSimCommandExecutor::DtSimCommandExecutor ( const DtSimCommandExecutor &  orig )

private

Not implemented.

Member Function Documentation

virtual bool DtSimCommandExecutor::executeAndDistribute ( const DtSimCommand *  command, const DtPlan *  plan = 0  )

virtual

Executes and then distributes the sim command by calling the execute and distribute functions in turn.

Returns

True if the execute command was successful.

virtual bool DtSimCommandExecutor::executeAndDistribute ( const DtSimCommand *  command, const DtUUID &  objectName, const DtPlan *  plan = 0  )

virtual

Executes and then distributes the sim command in the context of a specific entity by calling the execute and distribute functions in turn.

Returns

True if the execute command was successful.

static void DtSimCommandExecutor::setFactory ( DtSimCommandExecutorFactory *  factory )

static

Sets the static factory member.

static DtSimCommandExecutor* DtSimCommandExecutor::createSimCommandExecutor ( const DtSimCommandMessageType &  type, DtSimManager *  simManager  )

static

Uses the static factory member to create a new executor of the specified type.

virtual bool DtSimCommandExecutor::execute ( const DtSimCommand *  command, const DtPlan *  plan = 0  )

protectedpure virtual

Perform the actual execution of the DtSimCommand.

Pure virtual function; must be overloaded by derived classes. This method executes the command in the global context. If the command should be executed differently when in the context of a specific entity (i.e. in that entity's plan), see execute() which takes an object name.

Returns

True if command was successfully carried out, false otherwise.

Implemented in DtSimCommandDistributionExecutor, DtDeleteObjectCommandExecutor, DtConsoleMessageCommandExecutor, DtCreateObjectCommandExecutor, DtAbandonPlanCommandExecutor, DtLaunchGlobalPlanCommandExecutor, DtNoopCommandExecutor, DtRestartPlanCommandExecutor, DtChangeHostilityCommandExecutor, DtChangeTimeOfDayCommandExecutor, DtIssuePlanCommandExecutor, DtScenarioEventCommandExecutor, DtChangeWeatherCommandExecutor, DtSetDataCommandExecutor, DtStealthCommandExecutor, DtTaskCommandExecutor, and MySimCommandExecutor.

virtual bool DtSimCommandExecutor::execute ( const DtSimCommand *  command, const DtUUID &  objectName, const DtPlan *  plan = 0  )

protectedvirtual

Performs the actual executor of the DtSimCommand in the context of a specific entity.

The default implementation of this is to call execute(command), and simply throw out the objectName. This method should be reimplemented by deriving classes if the command is executed differently when in in the context of an object.

Reimplemented in DtConsoleMessageCommandExecutor, DtDeleteObjectCommandExecutor, DtSetDataCommandExecutor, DtTaskCommandExecutor, DtLaunchGlobalPlanCommandExecutor, DtStealthCommandExecutor, and MySimCommandExecutor.

virtual void DtSimCommandExecutor::distribute ( const DtSimCommand *  command, const DtPlan *  plan = 0  )

protectedvirtual

Calls on the sim command distributor to distribute the command to registered callback functions.

virtual void DtSimCommandExecutor::distribute ( const DtSimCommand *  command, const DtUUID &  objectName, const DtPlan *  plan = 0  )

protectedvirtual

Calls on the sim command distributor to distribute the command to registered callback functions, providing the context of a specific entity.

The default implementation of this is to call distribute(command), and simply throw out the objectName. This method should be reimplemented by deriving classes if the command is executed differently when in in the context of an object. The default sim command distributor does not support specific entity contexts.

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

private

Not implemented.

Member Data Documentation

DtSimManager* DtSimCommandExecutor::mySimManager

protected

DtSimCommandExecutorFactory* DtSimCommandExecutor::myFactory

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/simCommandExecutor.h