DtFixedWingLandingDescriptor Class Reference

This descriptor defines parameters that are used to create an approach vector to a landing strip. More...

Inheritance diagram for DtFixedWingLandingDescriptor:

List of all members.

Public Member Functions
	DtFixedWingLandingDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtFixedWingLandingDescriptor (const DtFixedWingLandingDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtFixedWingLandingDescriptor &	operator= (const DtFixedWingLandingDescriptor &orig)
	assignment
virtual	~DtFixedWingLandingDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	publishApproachRoute () const
	Accessor/mutator for myPublishApproachRoute.
virtual void	setPublishApproachRoute (bool)
	Accessor/mutator for myPublishApproachRoute.
virtual void	setLandingSpeedRatio (double)
	Accessor/mutator for myLandingSpeedRatio.
virtual double	landingSpeedRatio () const
	Accessor/mutator for myLandingSpeedRatio.
virtual void	setLandingDescentRate (double)
	Accessor/mutator for myLandingDescentRate.
virtual double	landingDescentRate () const
	Accessor/mutator for myLandingDescentRate.
virtual void	setLandingGearDownDistance (double)
	Accessor/mutator for myLandingGearDownDistance.
virtual double	landingGearDownDistance () const
	Accessor/mutator for myLandingGearDownDistance.
virtual void	setApproachStartAltitude (double alt)
	Accessor/mutator for myApproachStartAltitude.
virtual double	approachStartAltitude () const
	Accessor/mutator for myApproachStartAltitude.
virtual void	setThresholdAltitude (double alt)
	Accessor/mutator for myThresholdAltitude.
virtual double	thresholdAltutude () const
	Accessor/mutator for myThresholdAltitude.
virtual void	setBaseLegLength (double value)
	Accessor/mutator for myBaseLegLength.
virtual double	baseLegLength ()
	Accessor/mutator for myBaseLegLength.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myLandingSpeedRatio
	Parameter Name: landing-speed-ratio Parameter Description: Ratio that is applied to minimum lift speed to set ordered speed during landing approach.
DtRwReal	myLandingDescentRate
	Parameter Name: landing-descent-rate Parameter Description: The decent rate to use to generate the approach route.
DtRwReal	myLandingGearDownDistance
	Parameter Name: landing-gear-down-distance Parameter Description: Percentage distance away from end point that the landing gear will be put down.
DtRwBoolean	myPublishApproachRoute
	Parameter Name: publish-approach-route Parameter Description: Publishes the route that is being followed for approach on the network.
DtRwReal	myThresholdAltitude
	Parameter Name: threshold-altitude Parameter Description: The altitude the plane will achieve while passing over the runway threshold.
DtRwReal	myApproachStartAltitude
	Parameter Name: approach-start-altitude Parameter Description: The altitude (above the runway) that the approach route will start.
DtRwReal	myBaseLegLength
	Parameter Name: base-leg-length Parameter Description: The length of the base leg of the approach route generated to get to the runway.
Private Member Functions
	DtFixedWingLandingDescriptor ()
	default constructor; not implemented

---

Detailed Description

This descriptor defines parameters that are used to create an approach vector to a landing strip.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtFixedWingLandingDescriptor::~DtFixedWingLandingDescriptor

(

)

[virtual]

destructor

DtFixedWingLandingDescriptor::DtFixedWingLandingDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingLandingDescriptor& DtFixedWingLandingDescriptor::operator=

(

const DtFixedWingLandingDescriptor &

orig

)

assignment

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

DtFixedWingLandingDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtFixedWingLandingDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

virtual bool DtFixedWingLandingDescriptor::publishApproachRoute

(

)

const [virtual]

Accessor/mutator for myPublishApproachRoute.

virtual void DtFixedWingLandingDescriptor::setPublishApproachRoute

(

bool

)

[virtual]

Accessor/mutator for myPublishApproachRoute.

virtual void DtFixedWingLandingDescriptor::setLandingSpeedRatio

(

double

)

[virtual]

Accessor/mutator for myLandingSpeedRatio.

virtual double DtFixedWingLandingDescriptor::landingSpeedRatio

(

)

const [virtual]

Accessor/mutator for myLandingSpeedRatio.

virtual void DtFixedWingLandingDescriptor::setLandingDescentRate

(

double

)

[virtual]

Accessor/mutator for myLandingDescentRate.

virtual double DtFixedWingLandingDescriptor::landingDescentRate

(

)

const [virtual]

Accessor/mutator for myLandingDescentRate.

virtual void DtFixedWingLandingDescriptor::setLandingGearDownDistance

(

double

)

[virtual]

Accessor/mutator for myLandingGearDownDistance.

virtual double DtFixedWingLandingDescriptor::landingGearDownDistance

(

)

const [virtual]

Accessor/mutator for myLandingGearDownDistance.

virtual void DtFixedWingLandingDescriptor::setApproachStartAltitude

(

double

alt

)

[virtual]

Accessor/mutator for myApproachStartAltitude.

virtual double DtFixedWingLandingDescriptor::approachStartAltitude

(

)

const [virtual]

Accessor/mutator for myApproachStartAltitude.

virtual void DtFixedWingLandingDescriptor::setThresholdAltitude

(

double

alt

)

[virtual]

Accessor/mutator for myThresholdAltitude.

virtual double DtFixedWingLandingDescriptor::thresholdAltutude

(

)

const [virtual]

Accessor/mutator for myThresholdAltitude.

virtual void DtFixedWingLandingDescriptor::setBaseLegLength

(

double

value

)

[virtual]

Accessor/mutator for myBaseLegLength.

virtual double DtFixedWingLandingDescriptor::baseLegLength

(

)

[virtual]

Accessor/mutator for myBaseLegLength.

---

Member Data Documentation

DtRwReal DtFixedWingLandingDescriptor::myLandingSpeedRatio [protected]

Parameter Name: landing-speed-ratio
Parameter Description: Ratio that is applied to minimum lift speed to set ordered speed during landing approach.

Value is defaulted to 1.05.
Parameter Default Value: 1.05

DtRwReal DtFixedWingLandingDescriptor::myLandingDescentRate [protected]

Parameter Name: landing-descent-rate
Parameter Description: The decent rate to use to generate the approach route.

Parameter Default Value: 5.0
Parameter Units: meters/second

DtRwReal DtFixedWingLandingDescriptor::myLandingGearDownDistance [protected]

Parameter Name: landing-gear-down-distance
Parameter Description: Percentage distance away from end point that the landing gear will be put down.

Parameter Default Value: .2
Parameter Units: meters

DtRwBoolean DtFixedWingLandingDescriptor::myPublishApproachRoute [protected]

Parameter Name: publish-approach-route
Parameter Description: Publishes the route that is being followed for approach on the network.

Parameter Default Value: True

DtRwReal DtFixedWingLandingDescriptor::myThresholdAltitude [protected]

Parameter Name: threshold-altitude
Parameter Description: The altitude the plane will achieve while passing over the runway threshold.

Parameter Default Value: 10.0 Parameter Units: meters

DtRwReal DtFixedWingLandingDescriptor::myApproachStartAltitude [protected]

Parameter Name: approach-start-altitude
Parameter Description: The altitude (above the runway) that the approach route will start.

Parameter Default Value: 333.0
Parameter Units: meters

DtRwReal DtFixedWingLandingDescriptor::myBaseLegLength [protected]

Parameter Name: base-leg-length
Parameter Description: The length of the base leg of the approach route generated to get to the runway.

The distance from the runway centerline where the start point of the approach route will be, if a base leg is necessary.
Parameter Default Value: 1000.0
Parameter Units: meters

---

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

• include/vrfobjparam/fixWngLandingDesc.h