MySimCommandExecutor Class Reference

Inheritance diagram for MySimCommandExecutor:

Public Member Functions
	MySimCommandExecutor (DtSimManager *simManager)
virtual	~MySimCommandExecutor ()
virtual bool	execute (const DtSimCommand *command, DtSimCommandContextPtr &, const DtPlan *=0)
	This DtSimCommandContextPtr is now used to indicate there is some context that the executor needs to finish up in order for this sim command to be complete.
virtual bool	execute (const DtSimCommand *command, DtSimCommandContextPtr &, const DtUUID &objectName, const DtPlan *=0)
	Performs the actual executor of the DtSimCommand in the context of a specific entity.
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.

Private Member Functions
	MySimCommandExecutor ()
	MySimCommandExecutor (const MySimCommandExecutor &orig)
MySimCommandExecutor &	operator= (const MySimCommandExecutor &orig)

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

Constructor & Destructor Documentation

MySimCommandExecutor::MySimCommandExecutor

(

DtSimManager *

simManager

)

virtual MySimCommandExecutor::~MySimCommandExecutor ( )

virtual

MySimCommandExecutor::MySimCommandExecutor ( )

private

MySimCommandExecutor::MySimCommandExecutor ( const MySimCommandExecutor &  orig )

private

Member Function Documentation

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

virtual

This DtSimCommandContextPtr is now used to indicate there is some context that the executor needs to finish up in order for this sim command to be complete.

If you fill in a context you also need to implement the isSimCommandComplete to determine when the context has been satisfied and return true from that to complete the implementation of this sim command. An example of where this is used is the entity create sim command when waiting for the terrain to page in

Implements DtSimCommandExecutor.

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

virtual

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 from DtSimCommandExecutor.

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

static

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

private

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/addSimCommand/addSimCommandSim/mySimCommandExecutor.h