DtRotaryWingMoveToLocationControllerComponent Class Reference

DtRotaryWingMoveToLocationControllerComponent; move to location behavior for a rotary-wing entity. More...

Inheritance diagram for DtRotaryWingMoveToLocationControllerComponent:

List of all members.

Public Member Functions
	DtRotaryWingMoveToLocationControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRotaryWingMoveToLocationControllerComponent ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processMoveToLocationTask (DtSimMessage *msg)
	Use information provided by the message to set control values.
Static Public Member Functions
static void	moveToLocationCallback (DtSimMessage *msg, void *usr)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of move-to-location tasks.
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 ()
	Overrides this so it can register its interest in MoveTo commands.
virtual bool	setupControlPoint ()
	If the working control point is not null, sets the control point to be the working control point.
virtual void	getDesiredPosition (DtVector &desiredPosition)
	Returns the position the helicopter wants to move to.
Protected Attributes
DtVector	myLocalAimingPoint
DtVector	myWorldAimingPoint
Private Member Functions
	DtRotaryWingMoveToLocationControllerComponent ()
	Default constructor; should not be called.
	DtRotaryWingMoveToLocationControllerComponent (const DtRotaryWingMoveToLocationControllerComponent &orig)
	copy constructor; shallow; does not copy the ports.
const DtRotaryWingMoveToLocationControllerComponent &	operator= (const DtRotaryWingMoveToLocationControllerComponent &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtRotaryWingMoveToLocationControllerComponent; move to location behavior for a rotary-wing entity.

DtRotaryWingMoveToLocationControllerComponent is a controller used to model the movement of a helicopter to a point

Uses Descriptor Type: DtRotaryWingPilotDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtRotaryWingMoveToLocationControllerComponent::DtRotaryWingMoveToLocationControllerComponent

(

)

[private]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtRotaryWingMoveToLocationControllerComponent::DtRotaryWingMoveToLocationControllerComponent

(

const DtRotaryWingMoveToLocationControllerComponent &

orig

)

[private]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtRotaryWingMoveToLocationType

Reimplemented from DtRotaryWingMoveToControllerComponent.

static void DtRotaryWingMoveToLocationControllerComponent::moveToLocationCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of move-to-location tasks.

virtual void DtRotaryWingMoveToLocationControllerComponent::processMoveToLocationTask

(

DtSimMessage *

msg

)

[virtual]

Use information provided by the message to set control values.

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

virtual void DtRotaryWingMoveToLocationControllerComponent::registerTaskMsgCallbacks

(

)

[protected, virtual]

Overrides this so it can register its interest in MoveTo commands.

Reimplemented from DtRotaryWingMoveToControllerComponent.

virtual bool DtRotaryWingMoveToLocationControllerComponent::setupControlPoint

(

)

[protected, virtual]

If the working control point is not null, sets the control point to be the working control point.

Otherwise, attempts to look up the control point using the control point name.

Reimplemented from DtRotaryWingMoveToControllerComponent.

virtual void DtRotaryWingMoveToLocationControllerComponent::getDesiredPosition

(

DtVector &

desiredPosition

)

[protected, virtual]

Returns the position the helicopter wants to move to.

Reimplemented from DtRotaryWingMoveToControllerComponent.

const DtRotaryWingMoveToLocationControllerComponent& DtRotaryWingMoveToLocationControllerComponent::operator=

(

const DtRotaryWingMoveToLocationControllerComponent &

orig

)

[private]

assignment operator; see comments on copy constructor!

---

Member Data Documentation

DtVector DtRotaryWingMoveToLocationControllerComponent::myLocalAimingPoint [protected]

DtVector DtRotaryWingMoveToLocationControllerComponent::myWorldAimingPoint [protected]

---

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

• include/vrfmodel/rotWngMvToLocCtl.h