DtGroundPatrolRouteController Class Reference

DtGroundPatrolRouteController is a controller that models patrolling along route behavior for ground vehicles. More...

Inheritance diagram for DtGroundPatrolRouteController:

List of all members.

Public Member Functions
	DtGroundPatrolRouteController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtGroundPatrolRouteController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processPatrolRouteTask (DtSimMessage *msg)
	Receive and process patrol route tasks.
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in patrolRoute commands.
virtual void	stop ()
	Overrides so we can call DtRoute::reset() to reverse our direction instead of actually stopping at the end of the route.
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
	DtGroundPatrolRouteController ()
	Default constructor; should not be called.
	DtGroundPatrolRouteController (const DtGroundPatrolRouteController &orig)
	copy constructor; shallow; does not copy the ports.
const DtGroundPatrolRouteController &	operator= (const DtGroundPatrolRouteController &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtGroundPatrolRouteController is a controller that models patrolling along route behavior for ground vehicles.

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

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtGroundPatrolRouteController::DtGroundPatrolRouteController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundPatrolRouteController::DtGroundPatrolRouteController

(

const DtGroundPatrolRouteController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtGroundAutoPatrolRouteType

Reimplemented from DtGroundMoveAlongControllerComponent.

static void DtGroundPatrolRouteController::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 DtGroundPatrolRouteController::processPatrolRouteTask

(

DtSimMessage *

msg

)

[virtual]

Receive and process patrol route tasks.

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

virtual void DtGroundPatrolRouteController::registerTaskMsgCallbacks

(

)

[virtual]

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

Reimplemented from DtGroundMoveAlongControllerComponent.

virtual void DtGroundPatrolRouteController::stop

(

)

[virtual]

Overrides so we can call DtRoute::reset() to reverse our direction instead of actually stopping at the end of the route.

Reimplemented from DtGroundMoveAlongControllerComponent.

const DtGroundPatrolRouteController& DtGroundPatrolRouteController::operator=

(

const DtGroundPatrolRouteController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

---

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

• include/vrfmodel/gndPtrlRtCtl.h