DtElevatingBallisticGunControllerDescriptor Class Reference

DtElevatingBallisticGunControllerDescriptor. More...

Inheritance diagram for DtElevatingBallisticGunControllerDescriptor:

List of all members.

Public Member Functions
	DtElevatingBallisticGunControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtElevatingBallisticGunControllerDescriptor (const DtElevatingBallisticGunControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtElevatingBallisticGunControllerDescriptor &	operator= (const DtElevatingBallisticGunControllerDescriptor &orig)
	assignment
virtual	~DtElevatingBallisticGunControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxElevationRate () const
	Accessor/mutator for myMaxElevationRate.
virtual void	setMaxElevationRate (DtReal maxElevationRate)
	Accessor/mutator for myMaxElevationRate.
virtual DtArtPartType	gunToControl () const
	Accessor/mutator for myGunToControl.
virtual void	setGunToControl (DtArtPartType gunToControl)
	Accessor/mutator for myGunToControl.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtElevatingBallisticGunControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxElevationRate
	Parameter Name: max-elevation-rate Parameter Description: The max elevation rate.
DtRwInt	myGunToControl
	Parameter Name: gun-to-control Parameter Description: The articulated part number to use for finding the part we're controlling on the entity.

---

Detailed Description

DtElevatingBallisticGunControllerDescriptor.

A DtBallisticGunControllerDescriptor that has additional information needed for providing parameters to an articulating (elevation only) ballistic gun controller (like a tank gun).

End User Description: It adds max elevation rate and the (gun) art part to control.

---

Constructor & Destructor Documentation

DtElevatingBallisticGunControllerDescriptor::DtElevatingBallisticGunControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtElevatingBallisticGunControllerDescriptor::DtElevatingBallisticGunControllerDescriptor	(	const DtElevatingBallisticGunControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtElevatingBallisticGunControllerDescriptor::~DtElevatingBallisticGunControllerDescriptor

(

)

[virtual]

destructor

DtElevatingBallisticGunControllerDescriptor::DtElevatingBallisticGunControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtElevatingBallisticGunControllerDescriptor& DtElevatingBallisticGunControllerDescriptor::operator=

(

const DtElevatingBallisticGunControllerDescriptor &

orig

)

assignment

virtual DtString DtElevatingBallisticGunControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtElevatingBalGunControllerDescriptorType

Reimplemented from DtBallisticGunControllerDescriptor.

virtual DtComponentDescriptor* DtElevatingBallisticGunControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtBallisticGunControllerDescriptor.

virtual DtReal DtElevatingBallisticGunControllerDescriptor::maxElevationRate

(

)

const [virtual]

Accessor/mutator for myMaxElevationRate.

virtual void DtElevatingBallisticGunControllerDescriptor::setMaxElevationRate

(

DtReal

maxElevationRate

)

[virtual]

Accessor/mutator for myMaxElevationRate.

virtual DtArtPartType DtElevatingBallisticGunControllerDescriptor::gunToControl

(

)

const [virtual]

Accessor/mutator for myGunToControl.

virtual void DtElevatingBallisticGunControllerDescriptor::setGunToControl

(

DtArtPartType

gunToControl

)

[virtual]

Accessor/mutator for myGunToControl.

static DtComponentDescriptor* DtElevatingBallisticGunControllerDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtBallisticGunControllerDescriptor.

---

Member Data Documentation

DtRwReal DtElevatingBallisticGunControllerDescriptor::myMaxElevationRate [protected]

Parameter Name: max-elevation-rate
Parameter Description: The max elevation rate.

Used to determine the control value to provide the gun actuator for elevation/depression.
Parameter Default Value: 0.0
Parameter Units: radians/second

DtRwInt DtElevatingBallisticGunControllerDescriptor::myGunToControl [protected]

Parameter Name: gun-to-control
Parameter Description: The articulated part number to use for finding the part we're controlling on the entity.

The articulated part number will be specified in the parameter descriptor for the actuator component that associated with that part.
Parameter Default Value: 0

---

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

• include/vrfobjparam/elBalGnCtlDsc.h