DtConsoleMessageCommandExecutor Class Reference

DtConsoleMessageCommandExecutor. More...

Inheritance diagram for DtConsoleMessageCommandExecutor:

Public Member Functions
	DtConsoleMessageCommandExecutor (DtSimManager *simManager)
virtual	~DtConsoleMessageCommandExecutor ()
virtual bool	execute (const DtSimCommand *command, DtSimCommandContextPtr &context, const DtPlan *=0)
	Prints message to the sim engine console.
virtual bool	execute (const DtSimCommand *command, DtSimCommandContextPtr &context, const DtUUID &object, const DtPlan *=0)
	Prints message to the objectConsole for the object.
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
	DtConsoleMessageCommandExecutor ()
	Not implemented.
	DtConsoleMessageCommandExecutor (const DtConsoleMessageCommandExecutor &orig)
	Not implemented.
DtConsoleMessageCommandExecutor &	operator= (const DtConsoleMessageCommandExecutor &orig)
	Not implemented.

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

Detailed Description

DtConsoleMessageCommandExecutor.

Executor for the DtConsoleMessageCommand DtSimCommand. Prints the text specified in the command to the console. If executed from a global plan, it is printed to the sim engine console. If executed from an entity plan, it is printed to the object console for that object.

Constructor & Destructor Documentation

DtConsoleMessageCommandExecutor::DtConsoleMessageCommandExecutor

(

DtSimManager *

simManager

)

virtual DtConsoleMessageCommandExecutor::~DtConsoleMessageCommandExecutor ( )

virtual

DtConsoleMessageCommandExecutor::DtConsoleMessageCommandExecutor ( )

private

Not implemented.

DtConsoleMessageCommandExecutor::DtConsoleMessageCommandExecutor ( const DtConsoleMessageCommandExecutor &  orig )

private

Not implemented.

Member Function Documentation

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

virtual

Prints message to the sim engine console.

Implements DtSimCommandExecutor.

virtual bool DtConsoleMessageCommandExecutor::execute ( const DtSimCommand *  command, DtSimCommandContextPtr &  context, const DtUUID &  object, const DtPlan *  = 0  )

virtual

Prints message to the objectConsole for the object.

Reimplemented from DtSimCommandExecutor.

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

static

Returns

A new instance of this class.

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

private

Not implemented.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplanmgr/consoleMessageCommandExecutor.h