DtGroundTurnToControllerComponent Class Reference

DtGroundTurnToControllerComponent is a controller models turning a ground vehicle in a given direction. More...

Inheritance diagram for DtGroundTurnToControllerComponent:

List of all members.

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

---

Detailed Description

DtGroundTurnToControllerComponent is a controller models turning a ground vehicle in a given direction.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtGroundTurnToControllerComponent::DtGroundTurnToControllerComponent

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundTurnToControllerComponent::DtGroundTurnToControllerComponent

(

const DtGroundTurnToControllerComponent &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

virtual void DtGroundTurnToControllerComponent::tick

(

)

[virtual]

Calculate new control values.

Reimplemented from DtSimComponent.

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

DtGroundAutoTurnToHeadingType

Reimplemented from DtGroundAutoControllerComponent.

static void DtGroundTurnToControllerComponent::turnToHeadingCallback	(	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 turn-to tasks.

virtual void DtGroundTurnToControllerComponent::processTurnToHeadingTask

(

DtSimMessage *

msg

)

[virtual]

static DtSimComponent* DtGroundTurnToControllerComponent::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 DtGroundTurnToControllerComponent::registerTaskMsgCallbacks

(

)

[virtual]

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

Reimplemented from DtTaskControllerComponent.

const DtGroundTurnToControllerComponent& DtGroundTurnToControllerComponent::operator=

(

const DtGroundTurnToControllerComponent &

orig

)

[protected]

assignment operator; see comments on copy constructor!

---

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

• include/vrfmodel/gndTurnToCntlr.h