DtGroundStopMovingControllerComponent Class Reference

DtGroundStopMovingControllerComponent models the control system required to stop a ground vehicle moving. More...

Inheritance diagram for DtGroundStopMovingControllerComponent:

List of all members.

Public Member Functions
	DtGroundStopMovingControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtGroundStopMovingControllerComponent ()
	destructor
virtual void	tick ()
	Calculate new control values.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in TurnTo commands.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
	DtGroundStopMovingControllerComponent ()
	Default constructor; should not be called.
	DtGroundStopMovingControllerComponent (const DtGroundStopMovingControllerComponent &orig)
	copy constructor; shallow; does not copy the ports.
const DtGroundStopMovingControllerComponent &	operator= (const DtGroundStopMovingControllerComponent &orig)
	assignment operator; see comments on copy constructor!

---

Detailed Description

DtGroundStopMovingControllerComponent models the control system required to stop a ground vehicle moving.

End User Description: Sets throttle to zero and applies the brake. Registers for DtStopMovingTask messages. Task is considered complete when the vehicle comes to a stop (linear and rotational velocity is zero).

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtGroundStopMovingControllerComponent::DtGroundStopMovingControllerComponent

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundStopMovingControllerComponent::DtGroundStopMovingControllerComponent

(

const DtGroundStopMovingControllerComponent &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

virtual void DtGroundStopMovingControllerComponent::tick

(

)

[virtual]

Calculate new control values.

Reimplemented from DtSimComponent.

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

DtGroundStopMovingControllerType

Reimplemented from DtGroundAutoControllerComponent.

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

virtual void DtGroundStopMovingControllerComponent::registerTaskMsgCallbacks

(

)

[virtual]

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

Reimplemented from DtTaskControllerComponent.

const DtGroundStopMovingControllerComponent& DtGroundStopMovingControllerComponent::operator=

(

const DtGroundStopMovingControllerComponent &

orig

)

[protected]

assignment operator; see comments on copy constructor!

---

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

• include/vrfmodel/gndStopMovingCntlr.h