DtTurretComponentDescriptor Class Reference

DtTurretComponentDescriptor is a DtComponentDescriptor that has additional parameter information for DtTurretActuatorComponent objects. More...

Inheritance diagram for DtTurretComponentDescriptor:

List of all members.

Public Member Functions
	DtTurretComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtTurretComponentDescriptor (const DtTurretComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtTurretComponentDescriptor &	operator= (const DtTurretComponentDescriptor &orig)
	assignment
virtual	~DtTurretComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	hasFixedAzimuth () const
	Accessor for myHasFixedAzimuth.
virtual DtReal	maxSlewRate () const
	Accessor/mutator for myMaxSlewRate.
virtual void	setMaxSlewRate (DtReal maxSlewRate)
	Accessor/mutator for myMaxSlewRate.
virtual DtReal	rightSlewLimit () const
	Accessors for slew limits.
virtual DtReal	leftSlewLimit () const
	Accessors for slew limits.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtTurretComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files. The values are copied to the PSR so that the turret controller can access the values as well.
DtRwReal	myMaxSlewRate
	Parameter Name: max-slew-rate Parameter Description: Maximum rate at which the turret can rotate.
DtRwBoolean	myHasFixedAzimuth
	Parameter Name: fixed-az Parameter Description: Indicates whether the gun rotates (azimuth), or has a fixed azimuth.
DtRwReal	myLeftSlewLimit
	Parameter Name: left-slew-limit Parameter Description: The left limit, i.e.
DtRwReal	myRightSlewLimit
	Parameter Name: right-slew-limit Parameter Description: The right limit, i.e.

---

Detailed Description

DtTurretComponentDescriptor is a DtComponentDescriptor that has additional parameter information for DtTurretActuatorComponent objects.

---

Constructor & Destructor Documentation

DtTurretComponentDescriptor::DtTurretComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtTurretComponentDescriptor::~DtTurretComponentDescriptor

(

)

[virtual]

destructor

DtTurretComponentDescriptor::DtTurretComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtTurretComponentDescriptor& DtTurretComponentDescriptor::operator=

(

const DtTurretComponentDescriptor &

orig

)

assignment

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

DtTurretComponentDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtTurretComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtTurretComponentDescriptor::maxSlewRate

(

)

const [virtual]

Accessor/mutator for myMaxSlewRate.

virtual void DtTurretComponentDescriptor::setMaxSlewRate

(

DtReal

maxSlewRate

)

[virtual]

Accessor/mutator for myMaxSlewRate.

virtual bool DtTurretComponentDescriptor::hasFixedAzimuth

(

)

const [virtual]

Accessor for myHasFixedAzimuth.

virtual DtReal DtTurretComponentDescriptor::rightSlewLimit

(

)

const [virtual]

Accessors for slew limits.

virtual DtReal DtTurretComponentDescriptor::leftSlewLimit

(

)

const [virtual]

Accessors for slew limits.

static DtComponentDescriptor* DtTurretComponentDescriptor::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 DtActuatorComponentDescriptor.

---

Member Data Documentation

DtRwReal DtTurretComponentDescriptor::myMaxSlewRate [protected]

Parameter Name: max-slew-rate
Parameter Description: Maximum rate at which the turret can rotate.

Parameter Default Value: 0.
Parameter Units: radians/second

DtRwBoolean DtTurretComponentDescriptor::myHasFixedAzimuth [protected]

Parameter Name: fixed-az
Parameter Description: Indicates whether the gun rotates (azimuth), or has a fixed azimuth.

Parameter Default Value: False
Parameter Units: boolean value

DtRwReal DtTurretComponentDescriptor::myLeftSlewLimit [protected]

Parameter Name: left-slew-limit
Parameter Description: The left limit, i.e.

max counter-clockwise rotation as viewed from above, of the gun.
Zero is taken to be forward, i.e. (1, 0, 0), and ***positive angles go clockwise as viewed from above, because the entity z-axis points down.*** Example: a left-side gun might have a leftSlewLimit of -3 pi/4 and a rightSlewLimit of -pi/4.
If the gun can rotate 360 degrees, then both left and right limits should be set to 0.0.
If the gun is fixed, then this left limit is taken to be the fixed azimuth of the gun.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtTurretComponentDescriptor::myRightSlewLimit [protected]

Parameter Name: right-slew-limit
Parameter Description: The right limit, i.e.

the max clockwise rotation, of the gun. Zero is taken to be forward. If the gun is fixed, this parameter value is ignored.
If the gun can rotate 360 degrees, then both left and right limits should be set to 0.0.
Parameter Default Value: 0.0
Parameter Units: radians

---

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

• include/vrfobjparam/turCompDesc.h