DtAirVehicleWeaponHoldController Class Reference

DtAirVehicleWeaponHoldController provides a weapons-hold value based upon the altitude of the entity. More...

Inheritance diagram for DtAirVehicleWeaponHoldController:

List of all members.

Public Member Functions
	DtAirVehicleWeaponHoldController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtAirVehicleWeaponHoldController ()
	Destructor.
virtual bool	init ()
	Init. Call immediately after construction.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This components simulation tick.
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 ()
	Creates and initializes port groups.
virtual bool	createPorts ()
	Creates and initializes ports.
Protected Attributes
const DtAirVehicleWeaponHoldControllerDescriptor *	myDescriptor
	Pointer to this components descriptor.
Ports and Port Groups
Output Port Name: weapons-hold Output Port Description: Outputs True when the entity should not fire its weapons, and False if the weapons should be in weapons-free state. Output Port Range: True/False
DtBooleanOutputPort *	myWeaponsHoldPort
Private Member Functions
	DtAirVehicleWeaponHoldController ()
	Not Implemented.
	DtAirVehicleWeaponHoldController (const DtAirVehicleWeaponHoldController &orig)
	Not Implemented.
DtAirVehicleWeaponHoldController &	operator= (const DtAirVehicleWeaponHoldController &orig)
	Not Implemented.

---

Detailed Description

DtAirVehicleWeaponHoldController provides a weapons-hold value based upon the altitude of the entity.

End User Description: This controller provides a single boolean output called weapons-hold. When the altitude (above the terrain) of the entity on which this controller is mounted is above the min-weapon-fire-altitude, the weapons-hold output is false. Otherwise, it is true. To control the weapons-hold state, this output must be connected to either the weapons-hold input on the DtBallisticGunController or the DtWeaponController.

Component OPD Name: "air-vehicle-weapon-hold-controller" Uses Descriptor Type: DtAirVehicleWeaponHoldControllerDescriptor

---

Constructor & Destructor Documentation

DtAirVehicleWeaponHoldController::DtAirVehicleWeaponHoldController

(

)

[private]

Not Implemented.

DtAirVehicleWeaponHoldController::DtAirVehicleWeaponHoldController

(

const DtAirVehicleWeaponHoldController &

orig

)

[private]

Not Implemented.

DtAirVehicleWeaponHoldController::DtAirVehicleWeaponHoldController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString& name,

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& name, DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0)

virtual DtAirVehicleWeaponHoldController::~DtAirVehicleWeaponHoldController

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtAirVehicleWeaponHoldController& DtAirVehicleWeaponHoldController::operator=

(

const DtAirVehicleWeaponHoldController &

orig

)

[private]

Not Implemented.

virtual bool DtAirVehicleWeaponHoldController::init

(

)

[virtual]

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

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

DtAirVehicleWeaponHoldControllerType

Reimplemented from DtControllerComponent.

virtual void DtAirVehicleWeaponHoldController::tick

(

)

[virtual]

This components simulation tick.

Reimplemented from DtSimComponent.

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

(

)

[protected, virtual]

Creates and initializes port groups.

Reimplemented from DtSimComponent.

virtual bool DtAirVehicleWeaponHoldController::createPorts

(

)

[protected, virtual]

Creates and initializes ports.

Reimplemented from DtSimComponent.

---

Member Data Documentation

DtBooleanOutputPort* DtAirVehicleWeaponHoldController::myWeaponsHoldPort [protected]

const DtAirVehicleWeaponHoldControllerDescriptor* DtAirVehicleWeaponHoldController::myDescriptor [protected]

Pointer to this components descriptor.

---

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

• include/vrfmodel/airVehicleWeaponHoldController.h