DtHumanAimWeaponController Class Reference

This class is part of the human movement model which takes a heading as an input port, and stops the entity and faces it in the specified direction for as long as there is any data on the input port. More...

Inheritance diagram for DtHumanAimWeaponController:

List of all members.

Public Member Functions
	DtHumanAimWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtHumanAimWeaponController ()
	Destructor.
virtual bool	init ()
	Calls setRadio()
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This gives the thread of control to the component.
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
virtual bool	createPortGroups ()
	Overridden to create local port groups.
virtual bool	createPorts ()
	Overridden to create local ports.
virtual bool	createAimDirectionPort ()
Protected Attributes
Ports and Port Groups
DtAnalogInputPort *	myAimDirectionPort
	Input Port Name: aim-direction Input Port Description: Specifies the heading in which the entity should aim its weapon.
DtHumanMovementControlOutputPortGroup *	myHumanMovementControlOutputPortGroup
	Output Group Name: movement-control .
Private Member Functions
	DtHumanAimWeaponController ()
	default constructor; not implemented
	DtHumanAimWeaponController (const DtHumanAimWeaponController &orig)
	copy constructor; not implemented
const DtHumanAimWeaponController &	operator= (const DtHumanAimWeaponController &orig)
	assignment operator; not implemented

---

Detailed Description

This class is part of the human movement model which takes a heading as an input port, and stops the entity and faces it in the specified direction for as long as there is any data on the input port.

Control is only taken by this controller when there is data on the aimingDirection input port. Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

Destructor.

DtHumanAimWeaponController::DtHumanAimWeaponController

(

)

[private]

default constructor; not implemented

DtHumanAimWeaponController::DtHumanAimWeaponController

(

const DtHumanAimWeaponController &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

virtual bool DtHumanAimWeaponController::init

(

)

[virtual]

Calls setRadio()

Reimplemented from DtControllerComponent.

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

DtHumanAimWeaponControllerType

Reimplemented from DtControllerComponent.

virtual void DtHumanAimWeaponController::tick

(

)

[virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

static DtSimComponent* DtHumanAimWeaponController::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 bool DtHumanAimWeaponController::createPortGroups

(

)

[protected, virtual]

Overridden to create local port groups.

Reimplemented from DtSimComponent.

virtual bool DtHumanAimWeaponController::createPorts

(

)

[protected, virtual]

Overridden to create local ports.

Reimplemented from DtSimComponent.

virtual bool DtHumanAimWeaponController::createAimDirectionPort

(

)

[protected, virtual]

const DtHumanAimWeaponController& DtHumanAimWeaponController::operator=

(

const DtHumanAimWeaponController &

orig

)

[private]

assignment operator; not implemented

---

Member Data Documentation

DtAnalogInputPort* DtHumanAimWeaponController::myAimDirectionPort [protected]

Input Port Name: aim-direction
Input Port Description: Specifies the heading in which the entity should aim its weapon.

Input Port Range: Heading value in radians.
Input Port Default Value: N/A
Input Group Parent:

DtHumanMovementControlOutputPortGroup* DtHumanAimWeaponController::myHumanMovementControlOutputPortGroup [protected]

Output Group Name: movement-control
.

---

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

• include/vrfmodel/humanAimWeaponController.h