DtGroundMoveToLocationControllerComponent Class Reference

DtGroundMoveToLocationControllerComponent; models movement to a location for ground vehicles. More...

Inheritance diagram for DtGroundMoveToLocationControllerComponent:

List of all members.

Public Member Functions
	DtGroundMoveToLocationControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtGroundMoveToLocationControllerComponent ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processMoveToLocationTask (DtSimMessage *msg)
virtual void	registerTaskMsgCallbacks ()
	Overridden to register interest in move to and set location commands.
Static Public Member Functions
static void	moveToLocationCallback (DtSimMessage *msg, void *usr)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of move-to tasks.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Private Member Functions
	DtGroundMoveToLocationControllerComponent ()
	Default constructor; should not be called.
	DtGroundMoveToLocationControllerComponent (const DtGroundMoveToLocationControllerComponent &orig)
	copy constructor; shallow; does not copy the ports.
const DtGroundMoveToLocationControllerComponent &	operator= (const DtGroundMoveToDestinationControllerComponent &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtGroundMoveToLocationControllerComponent; models movement to a location for ground vehicles.

DtGroundMoveToControllerComponent is a controller that mdoels movement to a location for ground vehicles.

Developer Description: DtGroundMoveToLocationControllerComponent is derived from DtGroundMoveToDestinationControllerComponent and adds the ability to move towards a specified location.

Uses Descriptor Type: DtGroundMoveToDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtGroundMoveToLocationControllerComponent::DtGroundMoveToLocationControllerComponent

(

)

[private]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundMoveToLocationControllerComponent::DtGroundMoveToLocationControllerComponent

(

const DtGroundMoveToLocationControllerComponent &

orig

)

[private]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtGroundAutoMoveToLocationType

Reimplemented from DtGroundMoveToDestinationControllerComponent.

static void DtGroundMoveToLocationControllerComponent::moveToLocationCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

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

virtual void DtGroundMoveToLocationControllerComponent::processMoveToLocationTask

(

DtSimMessage *

msg

)

[virtual]

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

virtual void DtGroundMoveToLocationControllerComponent::registerTaskMsgCallbacks

(

)

[virtual]

Overridden to register interest in move to and set location commands.

Reimplemented from DtGroundMoveToDestinationControllerComponent.

const DtGroundMoveToLocationControllerComponent& DtGroundMoveToLocationControllerComponent::operator=

(

const DtGroundMoveToDestinationControllerComponent &

orig

)

[private]

assignment operator; see comments on copy constructor!

Reimplemented from DtGroundMoveToDestinationControllerComponent.

---

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

• include/vrfmodel/gndMvToLocCntlr.h