DtTurnAndMoveController Class Reference

Inheritance diagram for DtTurnAndMoveController:

List of all members.

Public Member Functions
	DtTurnAndMoveController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtTurnAndMoveController ()
virtual bool	init ()
	Calls setRadio()
virtual bool	createPSR ()
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	registerTaskMsgCallbacks ()
virtual void	processUserTask (DtSimMessage *msg)
virtual void	processTaskCompleteReport (DtSimMessage *msg)
virtual void	tick ()
	This gives the thread of control to the component.
Static Public Member Functions
static void	userTaskCallback (DtSimMessage *msg, void *usr)
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Protected Types
enum	DtControllerStates { StateTurning, StateMoving }
Protected Member Functions
virtual bool	startTurningPhase ()
virtual bool	startMovingPhase ()
virtual void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
Protected Attributes
DtTurnAndMoveControllerPSR *	myProcessState
Private Member Functions
	DtTurnAndMoveController ()
	DtTurnAndMoveController (const DtTurnAndMoveController &orig)
DtTurnAndMoveController &	operator= (const DtTurnAndMoveController &orig)

---

Member Enumeration Documentation

enum DtTurnAndMoveController::DtControllerStates [protected]

Enumerator:

StateTurning
StateMoving

---

Constructor & Destructor Documentation

DtTurnAndMoveController::DtTurnAndMoveController

(

)

[private]

DtTurnAndMoveController::DtTurnAndMoveController

(

const DtTurnAndMoveController &

orig

)

[private]

DtTurnAndMoveController::DtTurnAndMoveController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtTurnAndMoveController::~DtTurnAndMoveController

(

)

[virtual]

---

Member Function Documentation

DtTurnAndMoveController& DtTurnAndMoveController::operator=

(

const DtTurnAndMoveController &

orig

)

[private]

virtual bool DtTurnAndMoveController::init

(

)

[virtual]

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual bool DtTurnAndMoveController::createPSR

(

)

[virtual]

virtual DtString DtTurnAndMoveController::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Implements DtTaskControllerComponent.

virtual void DtTurnAndMoveController::registerTaskMsgCallbacks

(

)

[virtual]

Reimplemented from DtTaskControllerComponent.

static void DtTurnAndMoveController::userTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

virtual void DtTurnAndMoveController::processUserTask

(

DtSimMessage *

msg

)

[virtual]

static void DtTurnAndMoveController::taskCompleteReportCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

virtual void DtTurnAndMoveController::processTaskCompleteReport

(

DtSimMessage *

msg

)

[virtual]

virtual void DtTurnAndMoveController::tick

(

)

[virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual bool DtTurnAndMoveController::startTurningPhase

(

)

[protected, virtual]

virtual bool DtTurnAndMoveController::startMovingPhase

(

)

[protected, virtual]

virtual void DtTurnAndMoveController::clearTask

(

)

[protected, virtual]

If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.

Reimplemented from DtSingleTaskControllerComponent.

static DtSimComponent* DtTurnAndMoveController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

---

Member Data Documentation

DtTurnAndMoveControllerPSR* DtTurnAndMoveController::myProcessState [protected]

---

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

• examples/subtask/turnAndMoveController.h