The intention of this interface is for the script interface to interact with script task controllers in an abstract way so the bond between the controller and the interface, while coupled, not as tightly coupled. More...

Inheritance diagram for DtScriptTaskControllerInterface:

[legend]

Public Member Functions
virtual	~DtScriptTaskControllerInterface ()
virtual void	scriptSetTickPeriod (const DtString &scriptId, double period)=0
virtual void	scriptTaskComplete (int taskId, bool success)=0
virtual int	scriptSendSubtask (DtSimTask &task, int parentTaskId)=0
virtual std::vector< int >	scriptPendingSubstaskIds (int taskId)=0
virtual DtSubtaskStatusEntry *	scriptSubtaskStatus (int subtaskId, int parentTaskId)=0
virtual void	scriptClearSubtask (int subtaskId, int parentTaskId)=0
virtual int	scriptSendTask (DtSimTask &task, const DtString &entityName, int parentTaskId, bool actAsSubtask=true)=0
virtual void	notifyScriptTaskError (const DtString &scriptId, int taskId)=0

Protected Member Functions
	DtScriptTaskControllerInterface ()
	DtScriptTaskControllerInterface (const DtScriptTaskControllerInterface &other)
DtScriptTaskControllerInterface &	operator= (const DtScriptTaskControllerInterface &other)

Detailed Description

The intention of this interface is for the script interface to interact with script task controllers in an abstract way so the bond between the controller and the interface, while coupled, not as tightly coupled.

Any additional functions we need can be abstracted here for the script interface's use.

Constructor & Destructor Documentation

virtual DtScriptTaskControllerInterface::~DtScriptTaskControllerInterface ( )

virtual

DtScriptTaskControllerInterface::DtScriptTaskControllerInterface ( )

protected

DtScriptTaskControllerInterface::DtScriptTaskControllerInterface ( const DtScriptTaskControllerInterface & other )

protected

Member Function Documentation

virtual void DtScriptTaskControllerInterface::scriptSetTickPeriod	(	const DtString &	scriptId,
		double	period
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual void DtScriptTaskControllerInterface::scriptTaskComplete	(	int	taskId,
		bool	success
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual int DtScriptTaskControllerInterface::scriptSendSubtask	(	DtSimTask &	task,
		int	parentTaskId
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual std::vector<int> DtScriptTaskControllerInterface::scriptPendingSubstaskIds ( int taskId )

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual DtSubtaskStatusEntry* DtScriptTaskControllerInterface::scriptSubtaskStatus	(	int	subtaskId,
		int	parentTaskId
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual void DtScriptTaskControllerInterface::scriptClearSubtask	(	int	subtaskId,
		int	parentTaskId
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual int DtScriptTaskControllerInterface::scriptSendTask	(	DtSimTask &	task,
		const DtString &	entityName,
		int	parentTaskId,
		bool	actAsSubtask = `true`
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

virtual void DtScriptTaskControllerInterface::notifyScriptTaskError	(	const DtString &	scriptId,
		int	taskId
	)

pure virtual

Implemented in DtScriptMultiTaskController, and DtScriptReactiveTaskController.

DtScriptTaskControllerInterface& DtScriptTaskControllerInterface::operator= ( const DtScriptTaskControllerInterface & other )

protected

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation