DtSimCommandDistributionExecutor Class Reference

An executor for a sim command that has no specific execution, but should still be distributed to any registered callbacks. More...

Inheritance diagram for DtSimCommandDistributionExecutor:

Public Member Functions
	DtSimCommandDistributionExecutor (DtSimManager *simManager)
virtual	~DtSimCommandDistributionExecutor ()
Public Member Functions inherited from DtSimCommandExecutor
	DtSimCommandExecutor (DtSimManager *simManager)
virtual	~DtSimCommandExecutor ()
virtual bool	executeAndDistribute (const DtSimCommand *command, DtSimCommandContextPtr &context, 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, DtSimCommandContextPtr &context, 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.
virtual bool	isSimCommandComplete (const DtSimCommand *command, const DtSimCommandContextPtr &context, const DtPlan *=0) const
	Will, by default, return true to indicate the sim command is complete.
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.

Static Public Member Functions
static DtSimCommandExecutor *	create (DtSimManager *simManager)
Static Public Member Functions inherited from DtSimCommandExecutor
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, DtSimCommandContextPtr &context, const DtPlan *plan=0)
	Perform the actual execution of the DtSimCommand.
Protected Member Functions inherited from DtSimCommandExecutor
virtual bool	execute (const DtSimCommand *command, DtSimCommandContextPtr &context, const DtUUID &objectName, const DtPlan *plan=0)
	Performs the actual executor of the DtSimCommand in the context of a specific entity.

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

Additional Inherited Members
Protected Attributes inherited from DtSimCommandExecutor
DtSimManager *	mySimManager
Static Protected Attributes inherited from DtSimCommandExecutor
static DtSimCommandExecutorFactory *	myFactory

Detailed Description

An executor for a sim command that has no specific execution, but should still be distributed to any registered callbacks.

Constructor & Destructor Documentation

DtSimCommandDistributionExecutor::DtSimCommandDistributionExecutor ( DtSimManager *  simManager )

inline

virtual DtSimCommandDistributionExecutor::~DtSimCommandDistributionExecutor ( )

inlinevirtual

DtSimCommandDistributionExecutor::DtSimCommandDistributionExecutor ( )

private

Not implemented.

DtSimCommandDistributionExecutor::DtSimCommandDistributionExecutor ( const DtSimCommandDistributionExecutor &  orig )

private

Not implemented.

Member Function Documentation

static DtSimCommandExecutor* DtSimCommandDistributionExecutor::create ( DtSimManager *  simManager )

static

virtual bool DtSimCommandDistributionExecutor::execute ( const DtSimCommand *  command, DtSimCommandContextPtr &  context, const DtPlan *  plan = 0  )

inlineprotectedvirtual

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.

Implements DtSimCommandExecutor.

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

private

Not implemented.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfobjcore/simCommandExecutor.h