 |
VR-Forces 4.3.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3.1 Class Documentation
|
DtFixedWingFlyIntoControllerDescriptor; descriptor for the DtFixedWingFlyIntoControllerDescriptor component. More...
Public Member Functions | |
| DtFixedWingFlyIntoControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtFixedWingFlyIntoControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtFixedWingFlyIntoControllerDescriptor (const DtFixedWingFlyIntoControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtFixedWingFlyIntoControllerDescriptor & | operator= (const DtFixedWingFlyIntoControllerDescriptor &orig) |
| assignment | |
| virtual | ~DtFixedWingFlyIntoControllerDescriptor () |
| destructor | |
| virtual DtString | type () const |
| Returns the type of component this descriptor describes. | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual double | directFlyElevationAngle () const |
| Accessor/mutator for myDirectFlyElevationAngle. | |
| virtual void | setDirectFlyElevationAngle (double angle) |
| Accessor/mutator for myDirectFlyElevationAngle. | |
| virtual double | directFlyRange () const |
| Accessor/mutator for myDirectFlyRange. | |
| virtual void | setDirectFlyRange (double range) |
| Accessor/mutator for myDirectFlyRange. | |
 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 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 |
| 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. | |
| virtual void | setDebugActive (bool active) |
| Should detailed debug info be printed for this component. | |
| virtual bool | debugActive () const |
| Should detailed debug info be printed for this component. | |
| virtual void | setCreateComponent (bool yesNo) |
| Should the component be created or not. | |
| virtual bool | createComponent () const |
| Should the component be created 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) | |
| 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 (FILE *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 (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 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) |
| Deriving class overrides these to get/put class specific data. | |
| 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 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) |
| The variable name, if this object is a variable reference. | |
| 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 () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| 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 () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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 () |
| | |
Protected Member Functions | |
| DtFixedWingFlyIntoControllerDescriptor () | |
| 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. | |
| Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwReal | myDirectFlyElevationAngle |
| Parameter Name: direct-fly-elevation-angle Parameter Description: Get set the direct-fly elevation angle. | |
| DtRwReal | myDirectFlyRange |
| Parameter Name: direct-fly-range Parameter Description: Get set the direct-fly range. | |
| 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 |
| DtRwBoolean | myDebug |
| This parameter defaults to false. | |
| DtRwBoolean | myCreateComponent |
| 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 assoicated with this component. | |
| 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. | |
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 )() |
| Static Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
DtFixedWingFlyIntoControllerDescriptor; descriptor for the DtFixedWingFlyIntoControllerDescriptor component.
DtFixedWingFlyIntoControllerDescriptor is a kind of DtFixedWingPilotController that has additional information needed for providing parameters to the DtFixedWingFlyIntoController. Provides data on when to transition from level flight into "direct flight" (or flying directly toward the 3-dimensional target point).
| DtFixedWingFlyIntoControllerDescriptor::DtFixedWingFlyIntoControllerDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
constructor
| DtFixedWingFlyIntoControllerDescriptor::DtFixedWingFlyIntoControllerDescriptor | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtFixedWingFlyIntoControllerDescriptor::DtFixedWingFlyIntoControllerDescriptor | ( | const DtFixedWingFlyIntoControllerDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
virtual |
destructor
|
protected |
default constructor; not implemented
| DtFixedWingFlyIntoControllerDescriptor& DtFixedWingFlyIntoControllerDescriptor::operator= | ( | const DtFixedWingFlyIntoControllerDescriptor & | orig | ) |
assignment
|
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.
Reimplemented from DtFixedWingPilotControllerDescriptor.
|
virtual |
Reimplemented from DtFixedWingPilotControllerDescriptor.
|
virtual |
Accessor/mutator for myDirectFlyElevationAngle.
|
virtual |
Accessor/mutator for myDirectFlyElevationAngle.
|
virtual |
Accessor/mutator for myDirectFlyRange.
|
virtual |
Accessor/mutator for myDirectFlyRange.
|
static |
Reimplemented from DtFixedWingPilotControllerDescriptor.
|
protected |
Parameter Name: direct-fly-elevation-angle
Parameter Description: Get set the direct-fly elevation angle.
This specifies the minimum elevation angle (from the FW entity using this controller to the target position) at which the fly-into controller will transition from level flight to direct flight toward the target.
Parameter Default Value: 45.
Parameter Units: degrees
|
protected |
Parameter Name: direct-fly-range
Parameter Description: Get set the direct-fly range.
This specifies the minimum distance (from the FW entity using this controller to the target position) at which the fly-into controller will transition from level flight to direct flight toward the target.
Parameter Default Value: 200.
Parameter Units: meters