DtRotaryWingPatrolRouteController Class Reference

DtRotaryWingPatrolRouteController is a controller used to model patrolling along a route behavior for a rotary-wing entity. More...

Inheritance diagram for DtRotaryWingPatrolRouteController:

List of all members.

Public Member Functions
	DtRotaryWingPatrolRouteController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRotaryWingPatrolRouteController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processPatrolRouteTask (DtSimMessage *msg)
	Use information provided by the message to set control values.
virtual void	routeLogic ()
	Sets control values based on the status along the route each tick.
Static Public Member Functions
static void	patrolRouteCallback (DtSimMessage *msg, void *usrData)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of patrol-route tasks.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
	DtRotaryWingPatrolRouteController ()
	Default constructor; should not be called.
	DtRotaryWingPatrolRouteController (const DtRotaryWingPatrolRouteController &orig)
	copy constructor; shallow; does not copy the ports.
const DtRotaryWingPatrolRouteController &	operator= (const DtRotaryWingPatrolRouteController &orig)
	assignment operator; see comments on copy constructor!
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in patrolRoute commands.

---

Detailed Description

DtRotaryWingPatrolRouteController is a controller used to model patrolling along a route behavior for a rotary-wing entity.

End User Description: The route is followed until complete, then in reverse, then forward, etc., until the entity is retasked.

Uses Descriptor Type: DtRotaryWingPilotDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtRotaryWingPatrolRouteController::DtRotaryWingPatrolRouteController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtRotaryWingPatrolRouteController::DtRotaryWingPatrolRouteController

(

const DtRotaryWingPatrolRouteController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtRotaryWingPatrolRouteType

Reimplemented from DtRotaryWingMoveAlongControllerComponent.

static void DtRotaryWingPatrolRouteController::patrolRouteCallback	(	DtSimMessage *	msg,
		void *	usrData
	)		[static]

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

virtual void DtRotaryWingPatrolRouteController::processPatrolRouteTask

(

DtSimMessage *

msg

)

[virtual]

Use information provided by the message to set control values.

Gets the name of the route from the message. It looks up the route in the Object Manager to see if it exists. If it exists, it determines the nearest vertex of the route, calls startTask(), sets myProcessState->myReverseFlag to false, and deletes the message.

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

virtual void DtRotaryWingPatrolRouteController::routeLogic

(

)

[virtual]

Sets control values based on the status along the route each tick.

It maintains the entity at fully velocity unless it is approaching the last vertex on the route, in which case it reduces velocity to 75%.

Reimplemented from DtRotaryWingMoveAlongControllerComponent.

const DtRotaryWingPatrolRouteController& DtRotaryWingPatrolRouteController::operator=

(

const DtRotaryWingPatrolRouteController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

virtual void DtRotaryWingPatrolRouteController::registerTaskMsgCallbacks

(

)

[protected, virtual]

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

Reimplemented from DtRotaryWingMoveAlongControllerComponent.

---

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

• include/vrfmodel/rotWngPtrlRt.h