DtDisaggregatedTurnToHeadingController Class Reference

DtAggregateTurnToHeadingController is a task controller responsible for executing DtTurnToHeading tasks. More...

Inheritance diagram for DtDisaggregatedTurnToHeadingController:

List of all members.

Public Member Functions
	DtDisaggregatedTurnToHeadingController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDisaggregatedTurnToHeadingController ()
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	registerTaskMsgCallbacks ()
	Registers task and set data request callbacks for following type: DtTurnToHeadingType.
Static Public Member Functions
static void	turnToHeadingTaskCallback (DtSimMessage *msg, void *usr)
	Callback function for handling incoming turn to heading task message.
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
	Calls onTaskComplete to process the message.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
virtual void	onTurnToHeadingTask (DtSimMessage *msg)
	Issues DtMoveIntoFormationTask to ourself, at current location, heading given in incoming DtTurnToHeadingTask, keeping existing formation, and not applying formation to subordinates.
virtual void	onTaskComplete (DtSimMessage *msg)
	If tasked() is true and report is for a DtMoveIntoFormationTask type, calls taskComplete().
Private Member Functions
	DtDisaggregatedTurnToHeadingController (const DtDisaggregatedTurnToHeadingController &orig)
	not implemented
DtDisaggregatedTurnToHeadingController &	operator= (const DtDisaggregatedTurnToHeadingController &orig)
	not implemented

---

Detailed Description

DtAggregateTurnToHeadingController is a task controller responsible for executing DtTurnToHeading tasks.

End User Description: DtAggregateMoveToController models an aggregate's turn-to <heading> behavior. The behavior is implemented by issuing a move-into-formation subtask to itself, at the current location, current formation, and the heading given in the task. The DtAggregateMoveIntoFormationController executes the subtask. The task is considered complete when the move-into-formation subtask completes.

This controller may only be configured as a part of an entity that has a vrf-aggregate-state-repository.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtDisaggregatedTurnToHeadingController::~DtDisaggregatedTurnToHeadingController

(

)

[virtual]

DtDisaggregatedTurnToHeadingController::DtDisaggregatedTurnToHeadingController

(

const DtDisaggregatedTurnToHeadingController &

orig

)

[private]

not implemented

---

Member Function Documentation

virtual DtString DtDisaggregatedTurnToHeadingController::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.

Returns:

DtAggregateTurnToHeadingControllerType

Implements DtTaskControllerComponent.

virtual void DtDisaggregatedTurnToHeadingController::registerTaskMsgCallbacks

(

)

[virtual]

Registers task and set data request callbacks for following type: DtTurnToHeadingType.

Reimplemented from DtTaskControllerComponent.

static void DtDisaggregatedTurnToHeadingController::turnToHeadingTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

Callback function for handling incoming turn to heading task message.

Calls processTurnToHeadingTask to actually handle the message.

Parameters:

msg	Message containing a DtTurnToHeadingTask.
usr	Pointer to instance of this class.

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

Calls onTaskComplete to process the message.

Parameters:

msg	Message containing a DtTaskCompleteReport.
usr	Pointer to an instance of this class.

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

virtual void DtDisaggregatedTurnToHeadingController::onTurnToHeadingTask

(

DtSimMessage *

msg

)

[protected, virtual]

Issues DtMoveIntoFormationTask to ourself, at current location, heading given in incoming DtTurnToHeadingTask, keeping existing formation, and not applying formation to subordinates.

Parameters:

msg	Message containing a DtTurnToHeadingTask.

virtual void DtDisaggregatedTurnToHeadingController::onTaskComplete

(

DtSimMessage *

msg

)

[protected, virtual]

If tasked() is true and report is for a DtMoveIntoFormationTask type, calls taskComplete().

Parameters:

msg	Message containing a DtTaskCompleteReport.

DtDisaggregatedTurnToHeadingController& DtDisaggregatedTurnToHeadingController::operator=

(

const DtDisaggregatedTurnToHeadingController &

orig

)

[private]

not implemented

---

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

• include/vrfmodel/disaggregatedTurnToHeadingController.h