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:

[legend]

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.
Public Member Functions inherited from DtFixedWingPilotControllerDescriptor
	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 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.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtFixedWingFollowEntityControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtFixedWingPilotControllerDescriptor
	DtFixedWingPilotControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

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.
Protected Attributes inherited from DtFixedWingPilotControllerDescriptor
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.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation