DtFixedWingEmbarkationController Class Reference

DtFixedWingEmbarkationController is a controller used to model embarkation behavior for fixed-wing entities. More...

Inheritance diagram for DtFixedWingEmbarkationController:

List of all members.

Public Member Functions
	DtFixedWingEmbarkationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtFixedWingEmbarkationController ()
	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=DtVector(), const DtVector &velocty=DtVector())
	Overridden to provide bounding volume offset to loadPosition Note, that after calling the parent method, if the entity is on the ground, set the current speed to 0.
virtual void	issueMoveAlongToIngressTask ()
	Override to issue landing task to plane.
virtual void	issueMoveAlongToEgressTask ()
	Override to issue takeoff task to plane.
virtual void	processTaskComplete (DtSimMessage *msg)
	Override to capture landing task being complete.
virtual void	movingToEgress ()
	If the entitiy is no longer onGround (if it was on ground), then disembark from parent.
virtual void	movingToIngress ()
	When fixed wing is on ground, it is considered embarked.
virtual bool	init ()
	Initializes any state that is needed.
virtual void	setLocation (const DtVector &world)
	Sends setLocation request to this entity for the specified world location.
Protected Attributes
DtFixedWingEntityStateRepository *	myFixedWingEntityState
Private Member Functions
	DtFixedWingEmbarkationController ()
	default constructor; not implemented
	DtFixedWingEmbarkationController (const DtFixedWingEmbarkationController &orig)
	copy constructor; not implemented
const DtFixedWingEmbarkationController &	operator= (const DtFixedWingEmbarkationController &orig)
	assignment operator; not implemented

---

Detailed Description

DtFixedWingEmbarkationController is a controller used to model embarkation behavior for fixed-wing entities.

Developer Description: Overrides the DtEmbarkationController to not expect to send DtStopMovingTask, but, rather embark immediately after moved to emberkation point. Also invoke DtTaskLand to allow fixed wing to land on ingress route (if route) or DtTaskTakeOff if egress is a route.

Uses Descriptor Type: DtEmbarkationDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtFixedWingEmbarkationController::DtFixedWingEmbarkationController

(

)

[private]

default constructor; not implemented

DtFixedWingEmbarkationController::DtFixedWingEmbarkationController

(

const DtFixedWingEmbarkationController &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

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

DtFixedWingEmbarkationControllerType

Reimplemented from DtEmbarkationController.

static DtSimComponent* DtFixedWingEmbarkationController::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 DtFixedWingEmbarkationController::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 DtFixedWingEmbarkationController::embark	(	const DtVector &	loadPosition,
		const DtString &	parentName,
		int	appearance,
		const DtTaitBryan &	orientation,
		const DtVector &	acceleration = DtVector(),
		const DtVector &	velocty = DtVector()
	)		[protected, virtual]

Overridden to provide bounding volume offset to loadPosition Note, that after calling the parent method, if the entity is on the ground, set the current speed to 0.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::issueMoveAlongToIngressTask

(

)

[protected, virtual]

Override to issue landing task to plane.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::issueMoveAlongToEgressTask

(

)

[protected, virtual]

Override to issue takeoff task to plane.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::processTaskComplete

(

DtSimMessage *

msg

)

[protected, virtual]

Override to capture landing task being complete.

When it is complete we are considered at our embarked position as the last step of the landing controller is moving along the landing route

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::movingToEgress

(

)

[protected, virtual]

If the entitiy is no longer onGround (if it was on ground), then disembark from parent.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::movingToIngress

(

)

[protected, virtual]

When fixed wing is on ground, it is considered embarked.

Reimplemented from DtEmbarkationController.

virtual bool DtFixedWingEmbarkationController::init

(

)

[protected, virtual]

Initializes any state that is needed.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::setLocation

(

const DtVector &

)

[protected, virtual]

Sends setLocation request to this entity for the specified world location.

Reimplemented from DtEmbarkationController.

const DtFixedWingEmbarkationController& DtFixedWingEmbarkationController::operator=

(

const DtFixedWingEmbarkationController &

orig

)

[private]

assignment operator; not implemented

---

Member Data Documentation

DtFixedWingEntityStateRepository* DtFixedWingEmbarkationController::myFixedWingEntityState [protected]

---

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

• include/vrfmodel/fixWngEmbarkationController.h