DtFixedWingFollowEntityControllerDescriptor Class Reference

A DtFixedWingPilotControllerDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity. More...

Inheritance diagram for DtFixedWingFollowEntityControllerDescriptor:

List of all members.

Public Member Functions
	DtFixedWingFollowEntityControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtFixedWingFollowEntityControllerDescriptor (const DtFixedWingFollowEntityControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtFixedWingFollowEntityControllerDescriptor &	operator= (const DtFixedWingFollowEntityControllerDescriptor &orig)
	assignment
virtual	~DtFixedWingFollowEntityControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtReal	flyingCatchUpDistance () const
	Accessor/mutator for myFlyingCatchUpDistance.
virtual void	setFlyingCatchUpDistance (DtReal value)
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	groundNearCatchUpFactor () const
	Accessor/mutator for myGroundNearCatchUpFactor.
virtual void	setGroundNearCatchUpFactor (DtReal groundNearCatchUpFactor)
	Accessor/mutator for myGroundNearCatchUpFactor.
virtual DtReal	groundFarCatchUpFactor () const
	Accessor/mutator for myGroundFarCatchUpFactor.
virtual void	setGroundFarCatchUpFactor (DtReal groundFarCatchUpFactor)
	Accessor/mutator for myGroundFarCatchUpFactor.
virtual DtReal	groundPassedSlowDownFactor () const
	Accessor/mutator for myGroundPassedSlowDownFactor.
virtual void	setGroundPassedSlowDownFactor (DtReal groundPassedSlowDownFactor)
	Accessor/mutator for myGroundPassedSlowDownFactor.
virtual DtReal	flyingCatchUpFactor () const
	Accessor/mutator for myFlyingCatchUpFactor.
virtual void	setFlyingCatchUpFactor (DtReal value)
	Accessor/mutator for myFlyingCatchUpFactor.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtFixedWingFollowEntityControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myGroundNearCatchUpFactor
	Parameter Name: taxiing-near-catch-up-factor Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is 'near', but not 'at' the point at which it is supposed to be relative to the followed entity.
DtRwReal	myGroundFarCatchUpFactor
	Parameter Name: taxiing-far-catch-up-factor Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is further away from the followed entity than the 'near' distance.
DtRwReal	myGroundPassedSlowDownFactor
	Parameter Name: taxiing-passed-slow-down-factor Parameter Description: Sets and gets the speed the entity is to use if it is closer to the followed entity than the specified following distance.
DtRwReal	myFlyingCatchUpFactor
	Parameter Name: flying-catch-up-factor Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is further away from the followed entity than the flying-catch-up-distance distance.
DtRwReal	myFlyingCatchUpDistance
	Parameter Name: flying-catch-up-distance Parameter Description: When the aircraft is farther from it's desired location relative to the entity being following than this distance, it will use the flying-catch-up-factor speed to maneuver.

---

Detailed Description

A DtFixedWingPilotControllerDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity.

End User Description: The terms 'at' and 'near' are used with the same meaning as in the DtFixedWingMoveToDescriptor. You can set the at-distance, near-distance, passed-slow-down-factor, near-catch-up-factor, and far-catch-up-factor parameters in the object parameters database.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtFixedWingFollowEntityControllerDescriptor::~DtFixedWingFollowEntityControllerDescriptor

(

)

[virtual]

destructor

DtFixedWingFollowEntityControllerDescriptor::DtFixedWingFollowEntityControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingFollowEntityControllerDescriptor& DtFixedWingFollowEntityControllerDescriptor::operator=

(

const DtFixedWingFollowEntityControllerDescriptor &

orig

)

assignment

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

DtFixedWingFollowEntityControllerDescriptorType

Reimplemented from DtFixedWingPilotControllerDescriptor.

virtual DtReal DtFixedWingFollowEntityControllerDescriptor::groundNearCatchUpFactor

(

)

const [virtual]

Accessor/mutator for myGroundNearCatchUpFactor.

virtual void DtFixedWingFollowEntityControllerDescriptor::setGroundNearCatchUpFactor

(

DtReal

groundNearCatchUpFactor

)

[virtual]

Accessor/mutator for myGroundNearCatchUpFactor.

virtual DtReal DtFixedWingFollowEntityControllerDescriptor::groundFarCatchUpFactor

(

)

const [virtual]

Accessor/mutator for myGroundFarCatchUpFactor.

virtual void DtFixedWingFollowEntityControllerDescriptor::setGroundFarCatchUpFactor

(

DtReal

groundFarCatchUpFactor

)

[virtual]

Accessor/mutator for myGroundFarCatchUpFactor.

virtual DtReal DtFixedWingFollowEntityControllerDescriptor::groundPassedSlowDownFactor

(

)

const [virtual]

Accessor/mutator for myGroundPassedSlowDownFactor.

virtual void DtFixedWingFollowEntityControllerDescriptor::setGroundPassedSlowDownFactor

(

DtReal

groundPassedSlowDownFactor

)

[virtual]

Accessor/mutator for myGroundPassedSlowDownFactor.

virtual DtReal DtFixedWingFollowEntityControllerDescriptor::flyingCatchUpFactor

(

)

const [virtual]

Accessor/mutator for myFlyingCatchUpFactor.

virtual void DtFixedWingFollowEntityControllerDescriptor::setFlyingCatchUpFactor

(

DtReal

value

)

[virtual]

Accessor/mutator for myFlyingCatchUpFactor.

virtual DtReal DtFixedWingFollowEntityControllerDescriptor::flyingCatchUpDistance

(

)

const [virtual]

Accessor/mutator for myFlyingCatchUpDistance.

{@

virtual void DtFixedWingFollowEntityControllerDescriptor::setFlyingCatchUpDistance

(

DtReal

value

)

[virtual]

virtual DtComponentDescriptor* DtFixedWingFollowEntityControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtFixedWingPilotControllerDescriptor.

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

---

Member Data Documentation

DtRwReal DtFixedWingFollowEntityControllerDescriptor::myGroundNearCatchUpFactor [protected]

Parameter Name: taxiing-near-catch-up-factor
Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is 'near', but not 'at' the point at which it is supposed to be relative to the followed entity.

The default catchup factor is 1.1 times the speed of the entity being followed. This applies only to ground taxi of the aircraft. This parameter was called 'near-catch-up-factor' in VRF 3.9 and previous, and will also be read in by that name.
Parameter Default Value: 1.1

DtRwReal DtFixedWingFollowEntityControllerDescriptor::myGroundFarCatchUpFactor [protected]

Parameter Name: taxiing-far-catch-up-factor
Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is further away from the followed entity than the 'near' distance.

The default catchup factor is 1.25 times the speed of the entity being followed. This applies only to ground taxi of the aircraft. This parameter was called 'far-catch-up-factor' in VRF 3.9 and previous, and will also be read in by that name.
Parameter Default Value: 1.25

DtRwReal DtFixedWingFollowEntityControllerDescriptor::myGroundPassedSlowDownFactor [protected]

Parameter Name: taxiing-passed-slow-down-factor
Parameter Description: Sets and gets the speed the entity is to use if it is closer to the followed entity than the specified following distance.

The default slowdown factor is 0.1 times the speed of the followed entity. This applies only to ground taxi of the aircraft. This parameter was called 'passed-slow-down-factor' in VRF 3.9 and previous, and will also be read in by that name. Parameter Default Value: 0.1

DtRwReal DtFixedWingFollowEntityControllerDescriptor::myFlyingCatchUpFactor [protected]

Parameter Name: flying-catch-up-factor
Parameter Description: Sets and gets the speed the entity uses to catch up to the followed entity if it is further away from the followed entity than the flying-catch-up-distance distance.

This applies only when the aircraft is flying.
Parameter Default Value: 1.05

DtRwReal DtFixedWingFollowEntityControllerDescriptor::myFlyingCatchUpDistance [protected]

Parameter Name: flying-catch-up-distance
Parameter Description: When the aircraft is farther from it's desired location relative to the entity being following than this distance, it will use the flying-catch-up-factor speed to maneuver.

Parameter Default Value: 50.0 Parameter Units: meters

---

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

• include/vrfobjparam/fixWngFlwEntDesc.h