DtRotaryWingEmbarkationController Class Reference

DtRotaryWingEmbarkationController; models embarkation behavior for a rotary-wing entity. More...

Inheritance diagram for DtRotaryWingEmbarkationController:

List of all members.

Public Member Functions
	DtRotaryWingEmbarkationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRotaryWingEmbarkationController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	atEmbarkationPoint ()
	Embarks object on target (using myEmbarkationParent, myEmbarkationPoint member variables) by calling embark() method.
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	embark (const DtVector &loadPosition, const DtString &parentName, int appearance, const DtTaitBryan &orientation, const DtVector &acceleration, const DtVector &velocity)
	Overridden to provide bounding volume offset to loadPosition.
virtual void	disembark ()
	Overridden to unload entity at its current position.
virtual void	unload (const DtVector &unloadPosition)
	Overridden to unload entity at its current position when performing a task.
virtual void	issueMoveToEmbarkationPointTask ()
	Override to issue a task that is different than the default DtMoveTo task.
Private Member Functions
	DtRotaryWingEmbarkationController ()
	default constructor; not implemented
	DtRotaryWingEmbarkationController (const DtRotaryWingEmbarkationController &orig)
	copy constructor; not implemented
const DtRotaryWingEmbarkationController &	operator= (const DtRotaryWingEmbarkationController &orig)
	assignment operator; not implemented

---

Detailed Description

DtRotaryWingEmbarkationController; models embarkation behavior for a rotary-wing entity.

DtRotaryWingEmbarkationController is the embarkation controller configured on rotary wing entities.

Developer Description: Overridden to not send a DtStopMovingTask, but rather embark immediately after moved to emberkation point Uses Descriptor Type: DtEmbarkationDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtRotaryWingEmbarkationController::DtRotaryWingEmbarkationController

(

)

[private]

default constructor; not implemented

DtRotaryWingEmbarkationController::DtRotaryWingEmbarkationController

(

const DtRotaryWingEmbarkationController &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

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

DtRotaryWingEmbarkationControllerType

Reimplemented from DtEmbarkationController.

static DtSimComponent* DtRotaryWingEmbarkationController::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.

Reimplemented from DtEmbarkationController.

virtual void DtRotaryWingEmbarkationController::atEmbarkationPoint

(

)

[virtual]

Embarks object on target (using myEmbarkationParent, myEmbarkationPoint member variables) by calling embark() method.

Sends DtStopMovingTask and, when the task report complete is received, sets state to DtStoppedAtEmbarkationPoint

Reimplemented from DtEmbarkationController.

virtual void DtRotaryWingEmbarkationController::embark	(	const DtVector &	loadPosition,
		const DtString &	parentName,
		int	appearance,
		const DtTaitBryan &	orientation,
		const DtVector &	acceleration,
		const DtVector &	velocity
	)		[protected, virtual]

Overridden to provide bounding volume offset to loadPosition.

Reimplemented from DtEmbarkationController.

virtual void DtRotaryWingEmbarkationController::disembark

(

)

[protected, virtual]

Overridden to unload entity at its current position.

Reimplemented from DtEmbarkationController.

virtual void DtRotaryWingEmbarkationController::unload

(

const DtVector &

unloadPosition

)

[protected, virtual]

Overridden to unload entity at its current position when performing a task.

Reimplemented from DtEmbarkationController.

virtual void DtRotaryWingEmbarkationController::issueMoveToEmbarkationPointTask

(

)

[protected, virtual]

Override to issue a task that is different than the default DtMoveTo task.

Reimplemented from DtEmbarkationController.

const DtRotaryWingEmbarkationController& DtRotaryWingEmbarkationController::operator=

(

const DtRotaryWingEmbarkationController &

orig

)

[private]

assignment operator; not implemented

---

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

• include/vrfmodel/rotWngEmbarkationController.h