DtElevationMountComponentDescriptor Class Reference

A DtComponentDescriptor that has additional parameter information for DtMountingElevationActuator actuators. More...

Inheritance diagram for DtElevationMountComponentDescriptor:

List of all members.

Public Member Functions
	DtElevationMountComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtElevationMountComponentDescriptor (const DtElevationMountComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtElevationMountComponentDescriptor &	operator= (const DtElevationMountComponentDescriptor &orig)
	assignment
virtual	~DtElevationMountComponentDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxElevateRate () const
	Accessor/mutator for myMaxElevateRate.
virtual void	setMaxElevateRate (DtReal maxElevateRate)
	Accessor/mutator for myMaxElevateRate.
virtual DtReal	nominalElevation () const
	Accessor/mutator for myNominalElevation.
virtual void	setNominalElevation (DtReal nominalElevation)
	Accessor/mutator for myNominalElevation.
virtual DtReal	elevationRange () const
	Accessor/mutator for myElevationRange.
virtual void	setElevationRange (DtReal elevationRange)
	Accessor/mutator for myElevationRange.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtElevationMountComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myNominalElevation
	Parameter Name: nominal-elevation Parameter Description: Sets and gets the nominal elevation (radians).
DtRwReal	myElevationRange
	Parameter Name: elevation-range Parameter Description: Sets and gets the elevation range.
DtRwReal	myMaxElevateRate
	Parameter Name: max-elevate-rate Parameter Description: Sets and gets the maximum elevation rate (radians/second).

---

Detailed Description

A DtComponentDescriptor that has additional parameter information for DtMountingElevationActuator actuators.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtElevationMountComponentDescriptor::~DtElevationMountComponentDescriptor

(

)

[virtual]

DtElevationMountComponentDescriptor::DtElevationMountComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtElevationMountComponentDescriptor& DtElevationMountComponentDescriptor::operator=

(

const DtElevationMountComponentDescriptor &

orig

)

assignment

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

DtElevationMountComponentDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtElevationMountComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtElevationMountComponentDescriptor::maxElevateRate

(

)

const [virtual]

Accessor/mutator for myMaxElevateRate.

virtual void DtElevationMountComponentDescriptor::setMaxElevateRate

(

DtReal

maxElevateRate

)

[virtual]

Accessor/mutator for myMaxElevateRate.

virtual DtReal DtElevationMountComponentDescriptor::nominalElevation

(

)

const [virtual]

Accessor/mutator for myNominalElevation.

virtual void DtElevationMountComponentDescriptor::setNominalElevation

(

DtReal

nominalElevation

)

[virtual]

Accessor/mutator for myNominalElevation.

virtual DtReal DtElevationMountComponentDescriptor::elevationRange

(

)

const [virtual]

Accessor/mutator for myElevationRange.

virtual void DtElevationMountComponentDescriptor::setElevationRange

(

DtReal

elevationRange

)

[virtual]

Accessor/mutator for myElevationRange.

static DtComponentDescriptor* DtElevationMountComponentDescriptor::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 DtElevationMountComponentDescriptor::myNominalElevation [protected]

Parameter Name: nominal-elevation
Parameter Description: Sets and gets the nominal elevation (radians).

This angle is the center of the elevation mount's range.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtElevationMountComponentDescriptor::myElevationRange [protected]

Parameter Name: elevation-range
Parameter Description: Sets and gets the elevation range.

This is the angular extent through which the elevation mount can rotate.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtElevationMountComponentDescriptor::myMaxElevateRate [protected]

Parameter Name: max-elevate-rate
Parameter Description: Sets and gets the maximum elevation rate (radians/second).

This is the maximum rate at which the elevation mount can rotate.
Parameter Default Value: 0.0
Parameter Units: radians/second

---

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

• include/vrfobjparam/elevMntCpDesc.h