DtFixedWingLandingDescriptor Class Reference

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

Inheritance diagram for DtFixedWingLandingDescriptor:

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)
virtual void	setLandingSpeedRatio (double)
	Accessor/mutator for myLandingSpeedRatio.
virtual double	landingSpeedRatio () const
virtual void	setLandingDescentRate (double)
	Accessor/mutator for myLandingDescentRate.
virtual double	landingDescentRate () const
virtual void	setLandingGearDownDistance (double)
	Accessor/mutator for myLandingGearDownDistance.
virtual double	landingGearDownDistance () const
virtual void	setApproachStartAltitude (double alt)
	Accessor/mutator for myApproachStartAltitude.
virtual double	approachStartAltitude () const
virtual void	setThresholdAltitude (double alt)
	Accessor/mutator for myThresholdAltitude.
virtual double	thresholdAltutude () const
virtual void	setBaseLegLength (double value)
	Accessor/mutator for myBaseLegLength.
virtual double	baseLegLength ()
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 (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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.
bool	operator== (const DtComponentDescriptor &) const
	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
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
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object.
virtual bool	createOnRemoteObject () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

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.
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.
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 associated with this component.
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not.
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations.
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
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.

Private Member Functions
	DtFixedWingLandingDescriptor ()
	default constructor; not implemented

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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

virtual void DtFixedWingLandingDescriptor::setLandingSpeedRatio ( double  )

virtual

Accessor/mutator for myLandingSpeedRatio.

virtual double DtFixedWingLandingDescriptor::landingSpeedRatio ( ) const

virtual

virtual void DtFixedWingLandingDescriptor::setLandingDescentRate ( double  )

virtual

Accessor/mutator for myLandingDescentRate.

virtual double DtFixedWingLandingDescriptor::landingDescentRate ( ) const

virtual

virtual void DtFixedWingLandingDescriptor::setLandingGearDownDistance ( double  )

virtual

Accessor/mutator for myLandingGearDownDistance.

virtual double DtFixedWingLandingDescriptor::landingGearDownDistance ( ) const

virtual

virtual void DtFixedWingLandingDescriptor::setApproachStartAltitude ( double  alt )

virtual

Accessor/mutator for myApproachStartAltitude.

virtual double DtFixedWingLandingDescriptor::approachStartAltitude ( ) const

virtual

virtual void DtFixedWingLandingDescriptor::setThresholdAltitude ( double  alt )

virtual

Accessor/mutator for myThresholdAltitude.

virtual double DtFixedWingLandingDescriptor::thresholdAltutude ( ) const

virtual

virtual void DtFixedWingLandingDescriptor::setBaseLegLength ( double  value )

virtual

Accessor/mutator for myBaseLegLength.

virtual double DtFixedWingLandingDescriptor::baseLegLength ( )

virtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/fixedWingLandingDescriptor.h