DtFixedWingPilotControllerDescriptor Class Reference

DtFixedWingPilotControllerDescriptor; descriptor for the DtFixedWingPilotControllerDescriptor component. More...

Inheritance diagram for DtFixedWingPilotControllerDescriptor:

List of all members.

Public Member Functions
	DtFixedWingPilotControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtFixedWingPilotControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingPilotControllerDescriptor (const DtFixedWingPilotControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtFixedWingPilotControllerDescriptor &	operator= (const DtFixedWingPilotControllerDescriptor &orig)
	assignment
virtual	~DtFixedWingPilotControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtReal	maxTurnRateCutoffAngle () const
	Accessor/mutator for myMaxTurnRateCutoffAngle.
virtual void	setMaxTurnRateCutoffAngle (DtReal angle)
	Accessor/mutator for myMaxTurnRateCutoffAngle.
virtual DtReal	maxTurningGs () const
	Accessor/mutator for myMaxTurningGs.
virtual void	setMaxTurningGs (DtReal maxGs)
	Accessor/mutator for myMaxTurningGs.
virtual DtReal	maxPitchAngle () const
	Accessor/mutator for myMaxPitchAngle.
virtual void	setMaxPitchAngle (DtReal pitch)
	Accessor/mutator for myMaxPitchAngle.
virtual DtReal	atTime () const
	Accessor/mutator for myAtTime.
virtual void	setAtTime (DtReal atTime)
	Accessor/mutator for myAtTime.
virtual DtReal	nearTime () const
	Accessor/mutator for myNearTime.
virtual void	setNearTime (DtReal nearTime)
	Accessor/mutator for myNearTime.
virtual DtReal	maxTaxiingTurnSpeed () const
	Accessor/mutator for myMaxTaxiingTurnSpeed.
virtual void	setMaxTaxiingTurnSpeed (DtReal maxTaxiingTurnSpeed)
	Accessor/mutator for myMaxTaxiingTurnSpeed.
virtual DtReal	taxiingNearDistance () const
	Accessor/mutator for myTaxiingNearDistance.
virtual void	setTaxiingNearDistance (DtReal taxiingNearDistance)
	Accessor/mutator for myTaxiingNearDistance.
virtual DtReal	taxiingAtDistance () const
	Accessor/mutator for myTaxiingAtDistance.
virtual void	setTaxiingAtDistance (DtReal taxiingAtDistance)
	Accessor/mutator for myTaxiingAtDistance.
virtual DtReal	taxiingApproachSpeed () const
	Accessor/mutator for myTaxiingApproachSpeed.
virtual void	setTaxiingApproachSpeed (DtReal taxiingApproachSpeed)
	Accessor/mutator for myTaxiingApproachSpeed.
virtual DtReal	timeToTargetAltitude () const
	Accessor/mutator for myTimeToTargetAltitude.
virtual void	setTimeToTargetAltitude (DtReal value)
	Accessor/mutator for myTimeToTargetAltitude.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtFixedWingPilotControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxTurnRateCutoffAngle
	Parameter Name: max-turnrate-cutoff-angle Parameter Description: Specifies the turn angle (in radians) at which the entity will turn at its maximum turn rate.
DtRwReal	myMaxTurningGs
	Parameter Name: max-turning-Gs Parameter Description: Specifies the maximum acceleration, measured in Gs (9.8 m/s**2) that the pilot controller will allow in a banked turn.
DtRwReal	myMaxTaxiingTurnSpeed
	Parameter Name: max-taxiing-turn-speed Parameter Description: Parameter Default Value: 10.
DtRwReal	myMaxPitchAngle
	Parameter Name: max-pitch-angle Parameter Description: Specifies the maximum pitch (in radians) that the pilot will use to climb or dive to reach the desired altitude.
DtRwReal	myAtTime
	Parameter Name: at-time Parameter Description: The entity is considered to be at its goal when it will be at the goal in less than this value based on its current position and speed.
DtRwReal	myNearTime
	Parameter Name: near-time Parameter Description: The entity is considered to be near its goal when it will be at the goal in less than this value based on its current position and speed.
DtRwReal	myTaxiingAtDistance
	Parameter Name: taxiing-at-distance Parameter Description: Parameter Default Value: 1.
DtRwReal	myTaxiingNearDistance
	Parameter Name: taxiing-near-distance Parameter Description: Parameter Default Value: 25.
DtRwReal	myTaxiingApproachSpeed
	Parameter Name: taxiing-approach-speed Parameter Description: Parameter Default Value: 2.
DtRwReal	myTimeToTargetAltitude
	Parameter Name: time-to-target-altitude Parameter Description: This value is used to calculate the desired climb/decent rate of the plane.

---

Detailed Description

DtFixedWingPilotControllerDescriptor; descriptor for the DtFixedWingPilotControllerDescriptor component.

DtFixedWingPilotControllerDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to the DtFixedWingPilotController.

End User Description: It provides the maximum Gs allowed for a bank turn and the turn angle at which the max turn rate will be applied.

---

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtFixedWingPilotControllerDescriptor::~DtFixedWingPilotControllerDescriptor

(

)

[virtual]

destructor

DtFixedWingPilotControllerDescriptor::DtFixedWingPilotControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingPilotControllerDescriptor& DtFixedWingPilotControllerDescriptor::operator=

(

const DtFixedWingPilotControllerDescriptor &

orig

)

assignment

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

DtFixedWingPilotControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtFixedWingFollowEntityControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, and DtFixedWingDefaultControllerDescriptor.

virtual DtComponentDescriptor* DtFixedWingPilotControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtFixedWingFollowEntityControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, and DtFixedWingDefaultControllerDescriptor.

virtual DtReal DtFixedWingPilotControllerDescriptor::maxTurnRateCutoffAngle

(

)

const [virtual]

Accessor/mutator for myMaxTurnRateCutoffAngle.

virtual void DtFixedWingPilotControllerDescriptor::setMaxTurnRateCutoffAngle

(

DtReal

angle

)

[virtual]

Accessor/mutator for myMaxTurnRateCutoffAngle.

virtual DtReal DtFixedWingPilotControllerDescriptor::maxTurningGs

(

)

const [virtual]

Accessor/mutator for myMaxTurningGs.

virtual void DtFixedWingPilotControllerDescriptor::setMaxTurningGs

(

DtReal

maxGs

)

[virtual]

Accessor/mutator for myMaxTurningGs.

virtual DtReal DtFixedWingPilotControllerDescriptor::maxPitchAngle

(

)

const [virtual]

Accessor/mutator for myMaxPitchAngle.

virtual void DtFixedWingPilotControllerDescriptor::setMaxPitchAngle

(

DtReal

pitch

)

[virtual]

Accessor/mutator for myMaxPitchAngle.

virtual DtReal DtFixedWingPilotControllerDescriptor::atTime

(

)

const [virtual]

Accessor/mutator for myAtTime.

virtual void DtFixedWingPilotControllerDescriptor::setAtTime

(

DtReal

atTime

)

[virtual]

Accessor/mutator for myAtTime.

virtual DtReal DtFixedWingPilotControllerDescriptor::nearTime

(

)

const [virtual]

Accessor/mutator for myNearTime.

virtual void DtFixedWingPilotControllerDescriptor::setNearTime

(

DtReal

nearTime

)

[virtual]

Accessor/mutator for myNearTime.

virtual DtReal DtFixedWingPilotControllerDescriptor::maxTaxiingTurnSpeed

(

)

const [virtual]

Accessor/mutator for myMaxTaxiingTurnSpeed.

virtual void DtFixedWingPilotControllerDescriptor::setMaxTaxiingTurnSpeed

(

DtReal

maxTaxiingTurnSpeed

)

[virtual]

Accessor/mutator for myMaxTaxiingTurnSpeed.

virtual DtReal DtFixedWingPilotControllerDescriptor::taxiingNearDistance

(

)

const [virtual]

Accessor/mutator for myTaxiingNearDistance.

virtual void DtFixedWingPilotControllerDescriptor::setTaxiingNearDistance

(

DtReal

taxiingNearDistance

)

[virtual]

Accessor/mutator for myTaxiingNearDistance.

virtual DtReal DtFixedWingPilotControllerDescriptor::taxiingAtDistance

(

)

const [virtual]

Accessor/mutator for myTaxiingAtDistance.

virtual void DtFixedWingPilotControllerDescriptor::setTaxiingAtDistance

(

DtReal

taxiingAtDistance

)

[virtual]

Accessor/mutator for myTaxiingAtDistance.

virtual DtReal DtFixedWingPilotControllerDescriptor::taxiingApproachSpeed

(

)

const [virtual]

Accessor/mutator for myTaxiingApproachSpeed.

virtual void DtFixedWingPilotControllerDescriptor::setTaxiingApproachSpeed

(

DtReal

taxiingApproachSpeed

)

[virtual]

Accessor/mutator for myTaxiingApproachSpeed.

virtual DtReal DtFixedWingPilotControllerDescriptor::timeToTargetAltitude

(

)

const [virtual]

Accessor/mutator for myTimeToTargetAltitude.

virtual void DtFixedWingPilotControllerDescriptor::setTimeToTargetAltitude

(

DtReal

value

)

[virtual]

Accessor/mutator for myTimeToTargetAltitude.

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

Reimplemented in DtFixedWingFollowEntityControllerDescriptor, DtFixedWingFlyIntoControllerDescriptor, and DtFixedWingDefaultControllerDescriptor.

---

Member Data Documentation

DtRwReal DtFixedWingPilotControllerDescriptor::myMaxTurnRateCutoffAngle [protected]

Parameter Name: max-turnrate-cutoff-angle
Parameter Description: Specifies the turn angle (in radians) at which the entity will turn at its maximum turn rate.

The maximum turn rate (as specified by the fixed-wing entity pitch-rate parameter) is used at or above this angle. For turns that are less then the cutoff angle, the turn rate decreases linearly and proportionally to the ratio of the turn angle to the maxTurnRateCutoffAngle.
Parameter Default Value: .52 (30 degrees)
Parameter Units: radians

DtRwReal DtFixedWingPilotControllerDescriptor::myMaxTurningGs [protected]

Parameter Name: max-turning-Gs
Parameter Description: Specifies the maximum acceleration, measured in Gs (9.8 m/s**2) that the pilot controller will allow in a banked turn.

Parameter Default Value: 9.

DtRwReal DtFixedWingPilotControllerDescriptor::myMaxTaxiingTurnSpeed [protected]

Parameter Name: max-taxiing-turn-speed
Parameter Description:
Parameter Default Value: 10.

Parameter Units: meters/second

DtRwReal DtFixedWingPilotControllerDescriptor::myMaxPitchAngle [protected]

Parameter Name: max-pitch-angle
Parameter Description: Specifies the maximum pitch (in radians) that the pilot will use to climb or dive to reach the desired altitude.

This is independant from actual aircraft capabilities.
Parameter Default Value: .78 (45 degrees)
Parameter Units: radians

DtRwReal DtFixedWingPilotControllerDescriptor::myAtTime [protected]

Parameter Name: at-time Parameter Description: The entity is considered to be at its goal when it will be at the goal in less than this value based on its current position and speed.

Parameter Default Value: 2.0
Parameter Units: seconds

DtRwReal DtFixedWingPilotControllerDescriptor::myNearTime [protected]

Parameter Name: near-time
Parameter Description: The entity is considered to be near its goal when it will be at the goal in less than this value based on its current position and speed.

Parameter Default Value: 5.0
Parameter Units: seconds

DtRwReal DtFixedWingPilotControllerDescriptor::myTaxiingAtDistance [protected]

Parameter Name: taxiing-at-distance
Parameter Description:
Parameter Default Value: 1.

Parameter Units: meters

DtRwReal DtFixedWingPilotControllerDescriptor::myTaxiingNearDistance [protected]

Parameter Name: taxiing-near-distance
Parameter Description:
Parameter Default Value: 25.

Parameter Units: meters

DtRwReal DtFixedWingPilotControllerDescriptor::myTaxiingApproachSpeed [protected]

Parameter Name: taxiing-approach-speed
Parameter Description:
Parameter Default Value: 2.

Parameter Units: meters/second

DtRwReal DtFixedWingPilotControllerDescriptor::myTimeToTargetAltitude [protected]

Parameter Name: time-to-target-altitude
Parameter Description: This value is used to calculate the desired climb/decent rate of the plane.

The pilot controller will attempt to use a climb/decent rate which will reach the target altitude in the number of seconds specified here. The entity's max climb rate will be used if it is smaller than this value. Smaller values will cause more aggressive climb/decent rates.
Parameter Default Value: 4.
Parameter Units: seconds

---

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

• include/vrfobjparam/fixWngPltDesc.h