DtRotaryWingPatrolBetweenController Class Reference

DtRotaryWingPatrolBetweenController is a controller used to model patrolling between waypoints for a rotary-wing entity. More...

Inheritance diagram for DtRotaryWingPatrolBetweenController:

List of all members.

Public Member Functions
	DtRotaryWingPatrolBetweenController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRotaryWingPatrolBetweenController ()
	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	processPatrolBetweenTask (DtSimMessage *msg)
	Use information provided by the message to set control values.
virtual const DtString &	firstWaypoint () const
	Get/set first waypoint.
virtual void	setFirstWaypoint (const DtString &waypoint)
virtual const DtString &	secondWaypoint () const
	Get/set second waypoint.
virtual void	setSecondWaypoint (const DtString &waypoint)
Static Public Member Functions
static void	patrolBetweenCallback (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 between tasks.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Attributes
static DtReal	theDefaultRadius
Protected Member Functions
	DtRotaryWingPatrolBetweenController ()
	Default constructor; should not be called.
	DtRotaryWingPatrolBetweenController (const DtRotaryWingPatrolBetweenController &orig)
	copy constructor; shallow; does not copy the ports.
const DtRotaryWingPatrolBetweenController &	operator= (const DtRotaryWingPatrolBetweenController &orig)
	assignment operator; see comments on copy constructor!
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in patrolBetween commands.
virtual void	reverse ()
	Reverse direction.

---

Detailed Description

DtRotaryWingPatrolBetweenController is a controller used to model patrolling between waypoints for a rotary-wing entity.

End User Description: The entity moves to the first point, then the second, then the first, etc., until retasked.

Uses Descriptor Type: DtRotaryWingPilotDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtRotaryWingPatrolBetweenController::DtRotaryWingPatrolBetweenController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtRotaryWingPatrolBetweenController::DtRotaryWingPatrolBetweenController

(

const DtRotaryWingPatrolBetweenController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

virtual void DtRotaryWingPatrolBetweenController::tick

(

)

[virtual]

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

Reimplemented from DtRotaryWingMoveToControllerComponent.

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

DtRotaryWingPatrolBetweenType

Reimplemented from DtRotaryWingMoveToControllerComponent.

static void DtRotaryWingPatrolBetweenController::patrolBetweenCallback	(	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 between tasks.

virtual void DtRotaryWingPatrolBetweenController::processPatrolBetweenTask

(

DtSimMessage *

msg

)

[virtual]

Use information provided by the message to set control values.

virtual const DtString& DtRotaryWingPatrolBetweenController::firstWaypoint

(

)

const [virtual]

Get/set first waypoint.

virtual void DtRotaryWingPatrolBetweenController::setFirstWaypoint

(

const DtString &

waypoint

)

[virtual]

virtual const DtString& DtRotaryWingPatrolBetweenController::secondWaypoint

(

)

const [virtual]

Get/set second waypoint.

virtual void DtRotaryWingPatrolBetweenController::setSecondWaypoint

(

const DtString &

waypoint

)

[virtual]

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

const DtRotaryWingPatrolBetweenController& DtRotaryWingPatrolBetweenController::operator=

(

const DtRotaryWingPatrolBetweenController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

virtual void DtRotaryWingPatrolBetweenController::registerTaskMsgCallbacks

(

)

[protected, virtual]

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

Reimplemented from DtRotaryWingMoveToControllerComponent.

virtual void DtRotaryWingPatrolBetweenController::reverse

(

)

[protected, virtual]

Reverse direction.

If the myReverse flag is true, it sets myControlObject to mySecondWaypoint. If the flag is false, it sets myControlObject to myFirstWaypoint.

---

Member Data Documentation

DtReal DtRotaryWingPatrolBetweenController::theDefaultRadius [static]

---

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

• include/vrfmodel/rotWngPtlBtwn.h