DtGroundPatrolBetweenController Class Reference

DtGroundPatrolBetweenController is a controller that models patrolling between waypoint behavior for ground vehicles. More...

Inheritance diagram for DtGroundPatrolBetweenController:

List of all members.

Public Member Functions
	DtGroundPatrolBetweenController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtGroundPatrolBetweenController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processPatrolBetweenTask (DtSimMessage *msg)
	Receive and process patrol between tasks.
virtual const DtString &	firstWaypoint () const
	The first point to patrol between.
virtual void	setFirstWaypoint (const DtString &waypoint)
virtual const DtString &	secondWaypoint () const
	The second point to patrol between.
virtual void	setSecondWaypoint (const DtString &waypoint)
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in patrolBetween commands.
virtual void	stop ()
	Overrides to swap waypoints when either is reached.
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
	DtGroundPatrolBetweenController ()
	Default constructor; should not be called.
	DtGroundPatrolBetweenController (const DtGroundPatrolBetweenController &orig)
	copy constructor; shallow; does not copy the ports.
const DtGroundPatrolBetweenController &	operator= (const DtGroundPatrolBetweenController &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtGroundPatrolBetweenController is a controller that models patrolling between waypoint behavior for ground vehicles.

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

Uses Descriptor Type: DtGroundMoveToDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtGroundPatrolBetweenController::DtGroundPatrolBetweenController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundPatrolBetweenController::DtGroundPatrolBetweenController

(

const DtGroundPatrolBetweenController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtGroundAutoPatrolBetweenType

Reimplemented from DtGroundMoveToControllerComponent.

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

(

DtSimMessage *

msg

)

[virtual]

Receive and process patrol between tasks.

virtual const DtString& DtGroundPatrolBetweenController::firstWaypoint

(

)

const [virtual]

The first point to patrol between.

virtual void DtGroundPatrolBetweenController::setFirstWaypoint

(

const DtString &

waypoint

)

[virtual]

virtual const DtString& DtGroundPatrolBetweenController::secondWaypoint

(

)

const [virtual]

The second point to patrol between.

virtual void DtGroundPatrolBetweenController::setSecondWaypoint

(

const DtString &

waypoint

)

[virtual]

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

virtual void DtGroundPatrolBetweenController::registerTaskMsgCallbacks

(

)

[virtual]

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

Reimplemented from DtGroundMoveToControllerComponent.

virtual void DtGroundPatrolBetweenController::stop

(

)

[virtual]

Overrides to swap waypoints when either is reached.

Reimplemented from DtGroundMoveToDestinationControllerComponent.

const DtGroundPatrolBetweenController& DtGroundPatrolBetweenController::operator=

(

const DtGroundPatrolBetweenController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

---

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

• include/vrfmodel/gndPtlBtwnCtl.h