DtFixedWingPatrolBetweenController Class Reference

DtFixedWingPatrolBetweenController is a controller that models patrolling between waypoint behavior for fixed-wing entities. More...

Inheritance diagram for DtFixedWingPatrolBetweenController:

List of all members.

Public Member Functions
	DtFixedWingPatrolBetweenController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtFixedWingPatrolBetweenController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processPatrolBetweenTask (DtSimMessage *msg)
virtual const DtString &	firstWaypoint () const
virtual void	setFirstWaypoint (const DtString &waypoint)
virtual const DtString &	secondWaypoint () const
virtual void	setSecondWaypoint (const DtString &waypoint)
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in patrolBetween commands.
virtual void	doFinishing ()
	Override this so we can switch to the other waypoint when we arrive instead of completing the task.
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*,
Protected Member Functions
	DtFixedWingPatrolBetweenController ()
	Default constructor; should not be called.
	DtFixedWingPatrolBetweenController (const DtFixedWingPatrolBetweenController &orig)
	copy constructor; shallow; does not copy the ports.
const DtFixedWingPatrolBetweenController &	operator= (const DtFixedWingPatrolBetweenController &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtFixedWingPatrolBetweenController is a controller that models patrolling between waypoint behavior for fixed-wing entities.

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

Uses Descriptor Type: DtFixedWingPilotControllerDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtFixedWingPatrolBetweenController::DtFixedWingPatrolBetweenController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtFixedWingPatrolBetweenController::DtFixedWingPatrolBetweenController

(

const DtFixedWingPatrolBetweenController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtFixedWingPatrolBetweenControllerType

Reimplemented from DtFixedWingMoveToController.

static void DtFixedWingPatrolBetweenController::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 DtFixedWingPatrolBetweenController::processPatrolBetweenTask

(

DtSimMessage *

msg

)

[virtual]

virtual const DtString& DtFixedWingPatrolBetweenController::firstWaypoint

(

)

const [virtual]

virtual void DtFixedWingPatrolBetweenController::setFirstWaypoint

(

const DtString &

waypoint

)

[virtual]

virtual const DtString& DtFixedWingPatrolBetweenController::secondWaypoint

(

)

const [virtual]

virtual void DtFixedWingPatrolBetweenController::setSecondWaypoint

(

const DtString &

waypoint

)

[virtual]

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

virtual void DtFixedWingPatrolBetweenController::registerTaskMsgCallbacks

(

)

[virtual]

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

Reimplemented from DtFixedWingMoveToController.

virtual void DtFixedWingPatrolBetweenController::doFinishing

(

)

[virtual]

Override this so we can switch to the other waypoint when we arrive instead of completing the task.

Reimplemented from DtFixedWingMoveToController.

const DtFixedWingPatrolBetweenController& DtFixedWingPatrolBetweenController::operator=

(

const DtFixedWingPatrolBetweenController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

---

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

• include/vrfmodel/fixWngPtlBtwn.h