DtRotaryWingLandingController Class Reference

DtRotaryWingLandingController models landing behavior for rotary-wing entities. More...

Inheritance diagram for DtRotaryWingLandingController:

List of all members.

Public Member Functions
	DtRotaryWingLandingController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRotaryWingLandingController ()
	destructor
virtual void	tick ()
	Sets the desired position and velocity for use by the parent controller, then calls the parent’s tick() function.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	clearTask ()
	Overridden to deactivate the port group when this controller completes a task.
Static Public Member Functions
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	registerTaskMsgCallbacks ()
	Registers for radio messages.
virtual void	processLandingTask (DtSimMessage *msg)
	Starts the landing task.
virtual void	processTaskCompleteReport (DtSimMessage *msg)
	Responds to completion of the move-to subtask this task issues.
virtual bool	startMovingToLandingPosition ()
	Starts the task by issuing a move-to or move-along subtask, by calling sendMoveSubtask().
virtual bool	sendMoveSubtask (const DtString &destinationName)
	Sends either a move-to or a move-along subtask to the entity, depending on whether the destination has 1 or more vertices.
virtual void	doLanding ()
	Called from tick() to do the landing phase of the task.
virtual bool	landingPosition (DtVector &localPosition)
	Sets localPosition to the landing position (in local coords) based on the current task message.
virtual void	pilotProperties ()
	Sets the pilot properties.
Static Protected Member Functions
static void	landingTaskCallback (DtSimMessage *msg, void *usr)
	Calls processLandingTask().
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
	Calls processTaskCompleteReport().
Private Member Functions
	DtRotaryWingLandingController ()
	Not Implemented.
	DtRotaryWingLandingController (const DtRotaryWingLandingController &orig)
	Not Implemented.
const DtRotaryWingLandingController &	operator= (const DtRotaryWingLandingController &orig)
	Not Implemented.

---

Detailed Description

DtRotaryWingLandingController models landing behavior for rotary-wing entities.

End User Description: This controller lands a rotary wing entity at the position specified by the control object name in the DtVerticalLandingTask message. If the control object is a route, the controller first flies along the route, and then lands at the last point. The controller completes the task and sends a task complete report once the entity is on the ground.

Uses Descriptor Type: DtRotaryWingPilotDescriptor

---

Constructor & Destructor Documentation

DtRotaryWingLandingController::DtRotaryWingLandingController	(	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 DtRotaryWingLandingController::~DtRotaryWingLandingController

(

)

[virtual]

destructor

DtRotaryWingLandingController::DtRotaryWingLandingController

(

)

[private]

Not Implemented.

DtRotaryWingLandingController::DtRotaryWingLandingController

(

const DtRotaryWingLandingController &

orig

)

[private]

Not Implemented.

---

Member Function Documentation

virtual void DtRotaryWingLandingController::tick

(

)

[virtual]

Sets the desired position and velocity for use by the parent controller, then calls the parent’s tick() function.

Reimplemented from DtSimComponent.

virtual DtString DtRotaryWingLandingController::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:

DtRotaryWingLandingControllerType

Implements DtRotaryWingTaskController.

virtual void DtRotaryWingLandingController::clearTask

(

)

[virtual]

Overridden to deactivate the port group when this controller completes a task.

Reimplemented from DtRotaryWingTaskController.

static DtSimComponent* DtRotaryWingLandingController::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 DtRotaryWingLandingController::registerTaskMsgCallbacks

(

)

[protected, virtual]

Registers for radio messages.

Reimplemented from DtTaskControllerComponent.

static void DtRotaryWingLandingController::landingTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static, protected]

Calls processLandingTask().

virtual void DtRotaryWingLandingController::processLandingTask

(

DtSimMessage *

msg

)

[protected, virtual]

Starts the landing task.

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

Calls processTaskCompleteReport().

virtual void DtRotaryWingLandingController::processTaskCompleteReport

(

DtSimMessage *

msg

)

[protected, virtual]

Responds to completion of the move-to subtask this task issues.

virtual bool DtRotaryWingLandingController::startMovingToLandingPosition

(

)

[protected, virtual]

Starts the task by issuing a move-to or move-along subtask, by calling sendMoveSubtask().

virtual bool DtRotaryWingLandingController::sendMoveSubtask

(

const DtString &

destinationName

)

[protected, virtual]

Sends either a move-to or a move-along subtask to the entity, depending on whether the destination has 1 or more vertices.

Returns:

True when subtask successfully sent.

virtual void DtRotaryWingLandingController::doLanding

(

)

[protected, virtual]

Called from tick() to do the landing phase of the task.

virtual bool DtRotaryWingLandingController::landingPosition

(

DtVector &

localPosition

)

[protected, virtual]

Sets localPosition to the landing position (in local coords) based on the current task message.

Returns:

True on success, false if cannot calculate.

virtual void DtRotaryWingLandingController::pilotProperties

(

)

[protected, virtual]

Sets the pilot properties.

The position selector is 1.0 The velocity selector is 0.0 The acceleration selector is 0.0 The heading selector is 0.0. The aggressiveness value is set to the default aggressiveness.

const DtRotaryWingLandingController& DtRotaryWingLandingController::operator=

(

const DtRotaryWingLandingController &

orig

)

[private]

Not Implemented.

---

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

• include/vrfmodel/rotWingLandingController.h