DtRotaryWingActuatorDescriptor Class Reference

DtRotaryWingActuatorDescriptor; descriptor for the DtRotaryWingActuatorComponent component. More...

Inheritance diagram for DtRotaryWingActuatorDescriptor:

List of all members.

Public Member Functions
	DtRotaryWingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRotaryWingActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRotaryWingActuatorDescriptor (const DtRotaryWingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtRotaryWingActuatorDescriptor &	operator= (const DtRotaryWingActuatorDescriptor &orig)
	assignment
virtual	~DtRotaryWingActuatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setDefaults ()
	Set default values.
virtual void	copyValues (const DtRotaryWingActuatorDescriptor &orig)
virtual void	setDragCoefficient (double dc)
	Accessor/mutator for myDragCoefficient.
virtual double	dragCoefficient () const
virtual DtReal	maxSpeedAttitude () const
	Accessor/mutator for myMaxSpeedAttitude.
virtual void	setMaxSpeedAttitude (DtReal attitude)
	Accessor/mutator for myMaxSpeedAttitude.
virtual DtReal	crashVelocity () const
	Accessor/mutator for myCrashVelocity.
virtual void	setCrashVelocity (DtReal value)
	Accessor/mutator for myCrashVelocity.
virtual DtReal	landingPositionThreshold () const
	Accessor/mutator for myLandingPositionThreshold.
virtual void	setLandingPositionThreshold (DtReal value)
	Accessor/mutator for myLandingPositionThreshold.
virtual DtReal	landingVelocityThreshold () const
	Accessor/mutator for myLandingVelocityThreshold.
virtual void	setLandingVelocityThreshold (DtReal value)
	Accessor/mutator for myLandingVelocityThreshold.
virtual DtReal	landingHeightThreshold () const
	Accessor/mutator for myLandingHeightThreshold.
virtual void	setLandingHeightThreshold (DtReal value)
	Accessor/mutator for myLandingHeightThreshold.
virtual DtReal	clampedFrameRate () const
	Accessor/mutator for myClampedFrameRate.
virtual void	setClampedFrameRate (DtReal clampedFrameRate)
	Accessor/mutator for myClampedFrameRate.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtRotaryWingActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxSpeedAttitude
	Parameter Name: max-speed-attitude Parameter Description: The downward pitch required to fly at max speed.
DtRwReal	myCrashVelocity
	Parameter Name: crash-velocity Parameter Description: The crash velocity.
DtRwReal	myLandingPositionThreshold
	Parameter Name: landing-position-threshold Parameter Description: Landing position threshold.
DtRwReal	myLandingVelocityThreshold
	Parameter Name: landing-velocity-threshold Parameter Description: Landing velocity threshold.
DtRwReal	myLandingHeightThreshold
	Parameter Name: landing-height-threshold Parameter Description: The landing height threshold.
DtRwReal	myClampedFrameRate
	Parameter Name: clamped-frame-rate Parameter Description: The clamped frame rate.
DtRwReal	myDragCoefficient
	Parameter Name: drag-coefficient Parameter Description: This is amount of drag associated with this entity.

---

Detailed Description

DtRotaryWingActuatorDescriptor; descriptor for the DtRotaryWingActuatorComponent component.

A DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based rotary wing model -- maximum lift, yaw, pitch, and roll scalar accelerations.

---

Constructor & Destructor Documentation

DtRotaryWingActuatorDescriptor::DtRotaryWingActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtRotaryWingActuatorDescriptor::DtRotaryWingActuatorDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRotaryWingActuatorDescriptor::DtRotaryWingActuatorDescriptor	(	const DtRotaryWingActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtRotaryWingActuatorDescriptor::~DtRotaryWingActuatorDescriptor

(

)

[virtual]

DtRotaryWingActuatorDescriptor::DtRotaryWingActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtRotaryWingActuatorDescriptor& DtRotaryWingActuatorDescriptor::operator=

(

const DtRotaryWingActuatorDescriptor &

orig

)

assignment

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

DtRotaryWingActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtRotaryWingActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual void DtRotaryWingActuatorDescriptor::setDefaults

(

)

[virtual]

Set default values.

virtual void DtRotaryWingActuatorDescriptor::copyValues

(

const DtRotaryWingActuatorDescriptor &

orig

)

[virtual]

virtual DtReal DtRotaryWingActuatorDescriptor::maxSpeedAttitude

(

)

const [virtual]

Accessor/mutator for myMaxSpeedAttitude.

virtual void DtRotaryWingActuatorDescriptor::setMaxSpeedAttitude

(

DtReal

attitude

)

[virtual]

Accessor/mutator for myMaxSpeedAttitude.

virtual DtReal DtRotaryWingActuatorDescriptor::crashVelocity

(

)

const [virtual]

Accessor/mutator for myCrashVelocity.

virtual void DtRotaryWingActuatorDescriptor::setCrashVelocity

(

DtReal

value

)

[virtual]

Accessor/mutator for myCrashVelocity.

virtual DtReal DtRotaryWingActuatorDescriptor::landingPositionThreshold

(

)

const [virtual]

Accessor/mutator for myLandingPositionThreshold.

virtual void DtRotaryWingActuatorDescriptor::setLandingPositionThreshold

(

DtReal

value

)

[virtual]

Accessor/mutator for myLandingPositionThreshold.

virtual DtReal DtRotaryWingActuatorDescriptor::landingVelocityThreshold

(

)

const [virtual]

Accessor/mutator for myLandingVelocityThreshold.

virtual void DtRotaryWingActuatorDescriptor::setLandingVelocityThreshold

(

DtReal

value

)

[virtual]

Accessor/mutator for myLandingVelocityThreshold.

virtual DtReal DtRotaryWingActuatorDescriptor::landingHeightThreshold

(

)

const [virtual]

Accessor/mutator for myLandingHeightThreshold.

virtual void DtRotaryWingActuatorDescriptor::setLandingHeightThreshold

(

DtReal

value

)

[virtual]

Accessor/mutator for myLandingHeightThreshold.

virtual DtReal DtRotaryWingActuatorDescriptor::clampedFrameRate

(

)

const [virtual]

Accessor/mutator for myClampedFrameRate.

virtual void DtRotaryWingActuatorDescriptor::setClampedFrameRate

(

DtReal

clampedFrameRate

)

[virtual]

Accessor/mutator for myClampedFrameRate.

virtual void DtRotaryWingActuatorDescriptor::setDragCoefficient

(

double

dc

)

[virtual]

Accessor/mutator for myDragCoefficient.

This controls the amount of drag this entity experiences.

virtual double DtRotaryWingActuatorDescriptor::dragCoefficient

(

)

const [virtual]

static DtComponentDescriptor* DtRotaryWingActuatorDescriptor::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 DtRotaryWingActuatorDescriptor::myMaxSpeedAttitude [protected]

Parameter Name: max-speed-attitude
Parameter Description: The downward pitch required to fly at max speed.

Parameter Default Value: 0.1768 (10. degrees)
Parameter Units: radians

DtRwReal DtRotaryWingActuatorDescriptor::myCrashVelocity [protected]

Parameter Name: crash-velocity
Parameter Description: The crash velocity.

If the helicopter hits the ground harder than this, it is destroyed.
Parameter Default Value: 4.0
Parameter Units: meters/second

DtRwReal DtRotaryWingActuatorDescriptor::myLandingPositionThreshold [protected]

Parameter Name: landing-position-threshold
Parameter Description: Landing position threshold.

If the x-y delta between actual and desired position is less than this value, landing can occur.
Parameter Default Value: 10.0

DtRwReal DtRotaryWingActuatorDescriptor::myLandingVelocityThreshold [protected]

Parameter Name: landing-velocity-threshold
Parameter Description: Landing velocity threshold.

If the x-y value of desired velocity is less than this value, landing can occur.
Parameter Default Value: 5.0
Parameter Units: meters

DtRwReal DtRotaryWingActuatorDescriptor::myLandingHeightThreshold [protected]

Parameter Name: landing-height-threshold
Parameter Description: The landing height threshold.

If the helicopter is closer to the terrain than this (z-value), landing can occur.
Parameter Default Value: 2.0
Parameter Units: meters

DtRwReal DtRotaryWingActuatorDescriptor::myClampedFrameRate [protected]

Parameter Name: clamped-frame-rate
Parameter Description: The clamped frame rate.

If the frame rate (1 / dT) drops below this value, dT will be set to force this frame rate. Special Case: A frame rate of 0.0 means "Do not clamp." Parameter Default Value: 5.0
Parameter Units: Hertz

DtRwReal DtRotaryWingActuatorDescriptor::myDragCoefficient [protected]

Parameter Name: drag-coefficient
Parameter Description: This is amount of drag associated with this entity.

Parameter Default Value: 0.1

---

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

• include/vrfobjparam/rotWngActDesc.h