![]() |
VR-Forces 4.10 Class Documentation
|
DtSimpleRotaryWingPilot is a controller that represents the autopilot aspects of a rotary-wing pilot. More...

Public Member Functions | |
| DtSimpleRotaryWingPilot (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimpleRotaryWingPilot () |
| destructor More... | |
| virtual bool | init () |
| Calls the parent’s init() to initialize the ports. More... | |
| virtual bool | createPorts () |
| Overridden to create rotary wing ports. More... | |
| virtual const char * | type () const |
| Returns a string identifies the class type of component. More... | |
| virtual void | tick () |
| Calculate new control values. More... | |
| virtual bool | taskVisualizationsActive () const |
| Returns true if task visualizations are currently active for this component. More... | |
| virtual void | updateTaskVisualizations () |
| Called to update task visualizations after every tick. More... | |
Public Member Functions inherited from DtRotaryWingPilotController | |
| DtRotaryWingPilotController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtRotaryWingPilotController () |
| destructor More... | |
| virtual DtConstrainedAnalogOutputPort * | throttlePort () |
| virtual DtConstrainedAnalogOutputPort * | collectivePort () |
| virtual DtConstrainedDualAxisAnalogOutputPort * | cyclicPort () |
| virtual DtConstrainedAnalogOutputPort * | pedalPort () |
| virtual bool | createGuidancePortGroup () |
| Create the guidance input ports from the task controllers. More... | |
| virtual bool | createDesiredPositionPort () |
| virtual bool | createContinueMovementPort () |
| virtual bool | createDesiredVelocityPort () |
| virtual bool | createDesiredAccelerationPort () |
| virtual bool | createDesiredHeadingPort () |
| virtual bool | createPositionSelectorPort () |
| virtual bool | createVelocitySelectorPort () |
| virtual bool | createAccelerationSelectorPort () |
| virtual bool | createHeadingSelectorPort () |
| virtual bool | createPowerDownPort () |
| virtual bool | createAggressivenessPort () |
| Another input port, not part of the Guidance group. More... | |
| virtual DtAnalogInputPort * | aggressivenessPort () |
| virtual DtVectorInputPort * | desiredPositionPort () |
| Accessors for guidance ports. More... | |
| virtual DtBooleanInputPort * | continueMovementPort () |
| virtual DtVectorInputPort * | desiredVelocityPort () |
| virtual DtVectorInputPort * | desiredAccelerationPort () |
| virtual DtAnalogInputPort * | desiredHeadingPort () |
| virtual DtAnalogInputPort * | positionSelectorPort () |
| virtual DtAnalogInputPort * | velocitySelectorPort () |
| virtual DtAnalogInputPort * | accelerationSelectorPort () |
| virtual DtAnalogInputPort * | headingSelectorPort () |
| virtual DtBooleanInputPort * | powerDownPort () |
| virtual bool | createRotaryWingControlPortGroup () |
| These are called in init to create the ports used to communicate with the actuator. More... | |
| virtual bool | createThrottlePort () |
| virtual bool | createCollectivePort () |
| virtual bool | createCyclicPort () |
| virtual bool | createPedalPort () |
Public Member Functions inherited from DtControllerComponent | |
| DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtControllerComponent () |
| destructor More... | |
| virtual DtSimRadio * | radio () |
| The radio this component is listening to. More... | |
| virtual void | taskNotify (const DtSimTask &task) |
| This is used by the entity to notify all controllers that a new task has been received. More... | |
| virtual void | clearTask () |
| Called when you want to clear out this component's task state. More... | |
Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () |
| destructor More... | |
| virtual void | setParentSystem (DtComponentSystem *system) |
| Sets the parent system of this component. More... | |
| DtComponentSystem * | parentSystem () const |
| virtual bool | postAddComponentsInit () |
| Called after all components have been created, initialized and added to the component manager. More... | |
| virtual void | registerAttributeFunctions () |
| Called to register functions that provide system attribute values. More... | |
| virtual void | preFirstTickInit () |
| This function can be overridden to initialize a component before it is ticked for the first time. More... | |
| virtual void | postTick () |
| This function is called immediately after tick() is called. More... | |
| virtual void | timedTick () |
| This version of tick checks to see if the time to tick has arrived. More... | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as More... | |
| virtual double | minTickPeriod () const |
| access the minimum tick period More... | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time More... | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period More... | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. More... | |
| virtual double | nextTickTime () const |
| access the next tick time More... | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More... | |
| virtual double | calculateFirstTickTime () const |
| Returns the first time value that the component should tick at. More... | |
| virtual void | setEntity (DtVrfObject *entity) |
| The entity's state repository is the place that actuator components make updates and other components look to see our current state. More... | |
| virtual DtSimComponent * | nextComponent () |
| List management functions. More... | |
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| Used by DtComponentList. More... | |
| virtual DtListItem * | listItem () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. More... | |
| 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 actual stored. More... | |
| virtual void | addInputPort (DtInputPort *port) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. More... | |
| virtual void | removeInputPort (DtInputPort *port) |
| virtual DtInputPort * | lookupInputPort (const DtString &portName) |
| Returns a pointer to the input port registered on this component with the specified name. More... | |
| virtual DtList | inputPortList () const |
| Returns the list of DtInputPorts registered on this component. More... | |
| virtual void | addOutputPort (DtOutputPort *port) |
| Adds this output port to the components output port list so that other components can look it up and attach to it. More... | |
| virtual void | removeOutputPort (DtOutputPort *port) |
| virtual DtOutputPort * | lookupOutputPort (const DtString &portName) |
| Returns a pointer to the output port registered on this component with the specified name. More... | |
| virtual DtList | outputPortList () const |
| Returns the list of DtOutputPorts registered on this component. More... | |
| virtual void | addInputPortGroup (DtInputPortGroup *group) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. More... | |
| virtual void | removeInputPortGroup (DtInputPortGroup *group) |
| virtual DtInputPortGroup * | lookupInputPortGroup (const DtString &groupName) |
| Returns a pointer the input port group registered on this component with the specified name. More... | |
| virtual DtList | inputPortGroupList () const |
| Returns the list of DtInputPortGroups registered on this component. More... | |
| virtual void | addOutputPortGroup (DtOutputPortGroup *group) |
| Adds this output port group to the components output port group list so that other components can look it up and attach to it. More... | |
| virtual void | removeOutputPortGroup (DtOutputPortGroup *group) |
| virtual DtOutputPortGroup * | lookupOutputPortGroup (const DtString &groupName) |
| Returns a pointer the output port group registered on this component with the specified name. More... | |
| virtual DtList | outputPortGroupList () const |
| Returns the list of DtOutputPortGroups registered on this component. More... | |
| virtual int | priority () const |
| Return the current connection priority for this component. More... | |
| virtual void | setPriority (int priority) |
| Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. More... | |
| double | dT () const |
| This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More... | |
| virtual void | setDT (double deltaT) |
| Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. More... | |
| virtual void | setComponentDescriptor (DtComponentDescriptor *componentDescriptor) |
| The component descriptor specified in the order of battle file or parameter file that was used to create this component. More... | |
| virtual const DtComponentDescriptor * | componentDescriptor () const |
| virtual bool | tickWhileDestroyed () const |
| If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. More... | |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual const DtSymbolString & | componentFullName () const |
| DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. More... | |
| const DtPhysicalWorld * | physicalWorld () const |
| DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. More... | |
| const DtAttachedTerrain * | terrainAttachedTo () const |
| DtVrfObject * | entity () |
| Gets the entity. More... | |
| const DtVrfObject * | entity () const |
| const DtVrfObject * | const_entity () const |
| You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More... | |
| DtSimManager * | simManager () |
| Gets the sim manager. More... | |
| const DtSimManager * | simManager () const |
| const Coordinate_System * | coordinateSystem () const |
| Gets the coordinate system, as it should always exist if the physical world is in a valid state! More... | |
| DtVrfObjectStateRepository * | localStateRepository () |
| Gets the local state repository. More... | |
| const DtVrfObjectStateRepository * | localStateRepository () const |
| const DtVrfObjectStateRepository * | const_localStateRepository () const |
| You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More... | |
| virtual DtTaskVisualizationMap & | taskVisualizations () |
| Returns the list of task visualizations for this component. More... | |
| virtual bool | taskVisualizationsEnabled () const |
| Returns true if task visualizations are enabled for this component. More... | |
| virtual bool | isThreadSafe () const |
| Returns true if this component is marked as being thread safe. More... | |
| virtual void | addVRLinkDeferredJob (const boost::function< void()> &callback) |
| Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More... | |
| virtual void | enable () |
| Is this component enabled or not. More... | |
| virtual void | disable () |
| virtual bool | isEnabled () |
| virtual void | setIsEnabled (bool yesNo) |
| virtual DtOutputStream & | objectConsoleDebug (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleVerbose (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleInfo (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleWarn (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleError (const DtString &channel="") const |
| virtual DtSimResourceManager & | resourceManager () |
| virtual const DtSimResourceManager & | resourceManager () const |
Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| 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. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| 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. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| 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. More... | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More... | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| 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. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| 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. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| 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. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| 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. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
Static Public Member Functions | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| static DtReal | xyDistSquared (DtVector a, DtVector b) |
| Calculate the distance squared between the projections of the points onto the x-y plane. More... | |
Static Public Member Functions inherited from DtRotaryWingPilotController | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
Static Public Member Functions inherited from DtSimComponent | |
| static DtSimComponent * | MarkThreadSafe (DtSimComponent *) |
| Marks an instance of a component as being thread safe. More... | |
| static DtSimComponentFactory * | factory () |
| A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More... | |
| static void | setFactory (DtSimComponentFactory *factory) |
| static DtSimComponent * | createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More... | |
| static void | addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn) |
| Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More... | |
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. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Protected Member Functions | |
| virtual void | computeDesiredLinearAccel (DtVector &desiredHorizBodyAccel, double &desiredYawAccel) |
| Computes the desired linear acceleration (and estimate of desired body velocity) based on the control inputs, as identified by the selector port inputs. More... | |
| virtual void | computeDesiredTopoAccelToPosition (const double maxAccel, const double period, DtVector &desiredTopoAccel, double &yawAccel) |
| Computes the desired topo acceleration for movement toward a goal point, with or without a goal velocity at that point. More... | |
| virtual void | computeDesiredTopoAccelToVelocity (const DtVector &desiredVel, const double period, DtVector &desiredTopoAccel) |
| Computes the desired topo acceleration and yaw acceleration for movement controlled by a desired velocity vector alone. More... | |
| virtual double | desiredHeadingWithNoMoveGoal () |
| Computes the desired heading when there isn't a position or velocity goal input. More... | |
| virtual void | computeDesiredTopoAccelToHeading (const double desiredHeading, const double desiredSpeed, const double period, DtVector &desiredTopoAccel) |
| Computes the desired topo acceleration and yaw acceleration for movement along a heading. More... | |
| virtual void | checkLandNoFuel () |
| ................. More... | |
| virtual void | findEarthCurveDeltaPosition (DtVector fromPosition, DtVector toPosition, DtVector &deltaPosition, Coordinate_System *coordinateSystem) |
| Given from and to positions in local coordinates, and a coordinate system, compute a delta position whose vertical component is the difference in altitudes of the from and to positions. More... | |
| virtual void | limitAccelFromMaxForwardSpeed (const DtVector &topoVelocity, const double speedAtGoal, const double period, DtVector &desiredTopoAccel) |
| Computes a limiting acceleration such that the forward speed of the entity does not exceed its max speed or ordered speed (ordered speed does not apply if the goal position has a velocity). More... | |
| virtual void | limitAccelFromMaxAcceleration (DtVector &horizBodyAccel) |
| Limit acceleration based on maxAcceleration and maxStoppingDeceleration parameter limits. More... | |
| virtual void | computeTopoDeltaPosition (DtVector &topoDeltaPosition) |
| Computes the position error to the goal point in topo coordinates. More... | |
| virtual void | computeTopoDesiredEndVelocity (const DtVector &topoXyDeltaPos, DtVector &topoXyEndDirection, double &topoXyEndSpeed) |
| Determines the direction and magnitude of the velocity at the goal point. More... | |
| virtual void | computeAccelerationTowardGoal (const DtVector &topoCurrentXyVel, const DtVector &topoVelDirAtGoalPt, const double horizDesSpeedAtGoal, const DtVector &topoHorizDeltaPos, const double period, double &maxAccelTowardGoal) |
| Computes an acceleration toward a goal point to reach it and be at the desired speed when it is reached. More... | |
| virtual void | limitAccelForFixedFlightSlope (DtVector &topoDeltaPos, DtVector &topoCurrentXyVel, double &maxAccel) |
| This function is used when moving to a position, and with the continue flag port set true. More... | |
| virtual void | computeAccelerationPerpendicularToGoal (const DtVector &topoCurrentXyVel, const DtVector &topoVelDirAtGoalPt, const DtVector &horizDeltaPos, const double maxAccel, const double delayTime, double &maxAccelTowardGoal) |
| Determines the acceleration to use in the direction perpendicular to a line that goes through the desired end point and is aligned with the goal velocity direction. More... | |
| virtual void | computeVerticalAcceleration (const DtVector &topoDeltaPos, const double downSpeed, const double period, double &desiredZAccel) |
| Compute the desired z acceleration (up) from the given delta Z. More... | |
| virtual double | accelFromConstraintsAvoidingOvershoot (const double maxDecel, const double maxAccel, const double period, double speed, double targetDist, const double speedAtTarget) |
| Compute and return a value of acceleration such that the entity can use that acceleration for one period (tick), and then decelerate at up to maxDecel for an integral number of periods, and just reach a moving target point (targetDist -> 0) when it hits the target's speed. More... | |
| virtual bool | isCloseToGoalPosition (const DtVector &topoDeltaPos) |
| True if the horizontal distance to the goal position is less than a body length. More... | |
| virtual void | setCollectiveAndCyclicFromAccel (const DtVector &desiredAcceleration) |
| Sets the collective and collective from a desired acceleration input. More... | |
| virtual void | setPedalFromDesiredYawAcceleration (const double yawAccel) |
| virtual void | setThrottle () |
| Sets the throttle control output value. More... | |
| virtual DtReal | terrainAvoidanceVelocity () const |
| Calculate an upward desired velocity to maintain a safe distance from the terrain. More... | |
| virtual void | calculateTargetAlignmentAngle (DtReal &alignmentAngle) const |
| Calculate the angle to the target position input (port), or if none any target in a weapon PSR. More... | |
| virtual void | computeYawAccelerationToHeading (const double headingToPoint, const double period, double &yawAccel) |
| Computes a desired yaw acceleration to point the entity toward the given heading. More... | |
| virtual void | getTransformationMatrices () |
| Sets the myBodyToRef, myLocalToTopoDcm, and myTopoToLocalDcm. More... | |
| virtual double | stationaryGoalSpeedThreshold () |
| ! Constants More... | |
| virtual double | catchUpSpeedFactor () |
| When moving toward a moving goal, how much faster than the goal's speed the entity is allowed to move while it is approaching. More... | |
Protected Member Functions inherited from DtRotaryWingPilotController | |
| virtual bool | createPortGroups () |
| Overridden to call createRotaryWingControlPortGroup() and createGuidancePortGroup() More... | |
| virtual void | setStateFromPorts () |
| Sets the state repository variables from the ports. More... | |
| DtRotaryWingPilotController () | |
| default constructor; not implemented More... | |
| DtRotaryWingPilotController (const DtRotaryWingPilotController &orig) | |
| copy constructor; not implemented More... | |
| const DtRotaryWingPilotController & | operator= (const DtRotaryWingPilotController &orig) |
| assignment operator; not implemented More... | |
Protected Member Functions inherited from DtControllerComponent | |
| DtControllerComponent () | |
| default constructor More... | |
| DtControllerComponent (const DtControllerComponent &orig) | |
| copy constructor More... | |
| const DtControllerComponent & | operator= (const DtControllerComponent &orig) |
| assignment operator More... | |
| virtual void | onRestore () |
| Override to iterate over the descriptor to see if there are any targetting control tables. More... | |
| virtual void | initializeTargetingControlTableFromDescriptor (const DtReaderWriter *) |
| virtual void | setRadio (DtSimRadio *radio) |
Protected Member Functions inherited from DtSimComponent | |
| virtual double | computeCurrentTime () |
| Compute current time and myDT. More... | |
| bool | testInvariant () const |
| DtVrfProcessStateRepository * | createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true) |
| Creates a PSR for this component and registers it with the PSR manager. More... | |
| virtual void | destroyTaskVisualizations () |
| Destroys all task visualizations for this component. More... | |
| virtual void | destroyTaskVisualization (const DtString &name) |
| Destroys an existing task visualization. More... | |
| virtual DtPointTaskVisualizationPtr | pointTaskVisualization (const DtString &name) |
| Finds an existing or creates a new point task visualization with the given name. More... | |
| virtual DtLineTaskVisualizationPtr | lineTaskVisualization (const DtString &name) |
| Finds an existing or creates a new line task visualization with the given name. More... | |
| virtual DtAreaTaskVisualizationPtr | areaTaskVisualization (const DtString &name) |
| Finds an existing or creates a new area task visualization with the given name. More... | |
| virtual DtTextTaskVisualizationPtr | textTaskVisualization (const DtString &name) |
| Finds an existing or creates a new text task visualization with the given name. More... | |
| double | calculateNextTaskVisTickTime () const |
| Determines the next time the task visualizations should be ticked. More... | |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
Protected Attributes | |
| DtRotaryWingPilotDescriptor * | myPilotDescriptor |
| A pointer to the descriptor for this controller. More... | |
| DtDcm | myBodyToRef |
| The local orientation matrix. More... | |
| DtDcm | myLocalToTopoDcm |
| The local to topographic coordinate transformation matrix. More... | |
| DtDcm | myTopoToLocalDcm |
| The topographic to local coordinate transformation matrix. More... | |
| DtDcm | myTopoToBodyHeadingDcm |
| The 2D rotation about the yaw axis only. More... | |
Ports and Port Groups | |
| DtVectorInputPort * | myTargetLocationInputPort |
| Input Port Name: target-location Input Port Description: Accepts local database location of a target which the pilot should orient the aircraft to face, in the absence of other tasks. More... | |
Protected Attributes inherited from DtRotaryWingPilotController | |
| DtRotaryWingEntityStateRepository * | myRotaryWingEntityState |
| DtVector | myNormalizedBodyVelocity |
| DtOutputPortGroup * | myRotaryWingControlPortGroup |
| Output Port Group Name: rotary-wing-control Output Port Group Description: More... | |
| DtConstrainedAnalogOutputPort * | myThrottlePort |
| Output Port Name: throttle Output Port Description: The position of the throttle control. More... | |
| DtConstrainedAnalogOutputPort * | myCollectivePort |
| Output Port Name: collective Output Port Description: The position of the collective control. More... | |
| DtConstrainedDualAxisAnalogOutputPort * | myCyclicPort |
| Output Port Name: cyclic Output Port Description: The position of the collective control in X and Y. More... | |
| DtConstrainedAnalogOutputPort * | myPedalPort |
| Output Port Name: pedal Output Port Description: The position of the pedal controls. More... | |
| DtInputPortGroup * | myGuidancePortGroup |
| Input Port Group Name: guidance Input Port Group Description: Group of input ports that define the desired heading/position/velocity/acceleration and flight properties. More... | |
| DtVectorInputPort * | myDesiredPositionPort |
| Input Port Name: desired-position Input Port Description: The desired position of the entity. More... | |
| DtVectorInputPort * | myDesiredVelocityPort |
| Input Port Name: desired-velocity Input Port Description: The desired velocity of the entity Input Port Range: Database coordinates. More... | |
| DtVectorInputPort * | myDesiredAccelerationPort |
| Input Port Name: desired-acceleration Input Port Description: The desired acceleration of the entity Input Port Range: Database coordinates. More... | |
| DtAnalogInputPort * | myDesiredHeadingPort |
| Input Port Name: desired-heading Input Port Description: Input Port Range: -1. More... | |
| DtAnalogInputPort * | myPositionSelectorPort |
| Input Port Name: position-selector Input Port Description: Determines whether the desired-position port is used. More... | |
| DtBooleanInputPort * | myContinueMovementPort |
| Input Port Name: continue-movement Input Port Description: Indicates that when flying to a position, the entity should not come to a stop at the point. More... | |
| DtAnalogInputPort * | myVelocitySelectorPort |
| Input Port Name: velocity-selector Input Port Description: Determines whether the desired-velocity port is used. More... | |
| DtAnalogInputPort * | myAccelerationSelectorPort |
| Input Port Name: acceleration-selector Input Port Description: Determines whether the desired-acceleration port is used. More... | |
| DtAnalogInputPort * | myHeadingSelectorPort |
| Input Port Name: heading-selector Input Port Description: Determines whether the desired-heading port is used. More... | |
| DtAnalogInputPort * | myAggressivenessPort |
| Input Port Name: aggressiveness Input Port Description: How aggressively the autopilot will move the controls to gain the desired values. More... | |
| DtBooleanInputPort * | myPowerDownPort |
| Input Port Name: power-down Input Port Description: Determines whether the control values will all be set to 0. More... | |
Protected Attributes inherited from DtControllerComponent | |
| DtSimRadio * | myRadio |
| Controller components can send messages. More... | |
Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| Pointer to the DtComponentSystem that this component belongs. More... | |
| DtListItem * | myListItem |
| DtInputPortMap | myInputPortList |
| DtOutputPortMap | myOutputPortList |
| DtInputPortGroupMap | myInputPortGroupList |
| DtOutputPortGroupMap | myOutputPortGroupList |
| int | myPriority |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| double | myLastTickSimTime |
| double | myDT |
| bool | myIsEnabled |
| Indicates whether this component should be enabled for ticking or not. More... | |
| bool | myFirstTick |
| Initialized to true in the constructor, set to false by the first call to postTick. More... | |
| bool | myIsThreadSafe |
| Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More... | |
| const DtComponentDescriptor * | myComponentDescriptor |
| std::list < DtVrfProcessStateRepository * > | myComponentPsrs |
| List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More... | |
| bool | myTickEveryFrame |
| Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More... | |
| DtTaskVisualizationMap | myTaskVisualizations |
| The visualization objects to be drawn for this component. More... | |
| double | myNextTaskVisTickTime |
| The next tick time for updating the task visualizations. More... | |
| DtSymbolString | myFullComponentName |
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. More... | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. More... | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. More... | |
Private Member Functions | |
| DtSimpleRotaryWingPilot () | |
| default constructor not implemented More... | |
| DtSimpleRotaryWingPilot (const DtSimpleRotaryWingPilot &orig) | |
| copy constructor not implemented More... | |
| DtSimpleRotaryWingPilot & | operator= (const DtSimpleRotaryWingPilot &orig) |
| assignment operator not implemented More... | |
DtSimpleRotaryWingPilot is a controller that represents the autopilot aspects of a rotary-wing pilot.
End User Description: It sets the helicopter controls to achieve desired position, velocity, acceleration, and orientation. These values are provided over a set of input ports. The controller than uses these values to calculate the needed control inputs for the actuator, and sends these values on the output ports.
Uses Descriptor Type: DtRotaryWingPilotDescriptor
| DtSimpleRotaryWingPilot::DtSimpleRotaryWingPilot | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
|
virtual |
destructor
|
private |
default constructor not implemented
|
private |
copy constructor not implemented
|
virtual |
Calls the parent’s init() to initialize the ports.
Returns true if initialization was successful.
Reimplemented from DtRotaryWingPilotController.
|
virtual |
Overridden to create rotary wing ports.
Reimplemented from DtRotaryWingPilotController.
|
virtual |
Returns a string identifies the class type of component.
Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.
Reimplemented from DtRotaryWingPilotController.
|
virtual |
Calculate new control values.
Reimplemented from DtRotaryWingPilotController.
|
static |
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
|
virtual |
Returns true if task visualizations are currently active for this component.
Default behavior is to return false. Must be overridden in subclasses to enable task visualizations.
Reimplemented from DtSimComponent.
|
virtual |
Called to update task visualizations after every tick.
Implemented by subclasses.
Reimplemented from DtSimComponent.
|
private |
assignment operator not implemented
|
protectedvirtual |
Computes the desired linear acceleration (and estimate of desired body velocity) based on the control inputs, as identified by the selector port inputs.
Looks at the various selector inputs (position, velocity, acceleration, heading) to figure out what the goal is. For example, velocity alone is taken as the desired instantaneous velocity, but if there is position and velocity input, velocity is taken to be the desired velocity at the goal point.
| desiredHorizBodyAccel | is an output; it is the desired acceleration in a coordinate system with x a horizontal component in the forward direction (i.e. like body-x, but with no pitch); y a horizontal component to the right, and z the down component. |
| desiredYawAcceleration | is an output giving desired rotation around the down axis. |
|
protectedvirtual |
Computes the desired topo acceleration for movement toward a goal point, with or without a goal velocity at that point.
This function handles 3 possibilities:
|
protectedvirtual |
Computes the desired topo acceleration and yaw acceleration for movement controlled by a desired velocity vector alone.
Adds terrain avoidance velocity if required. If the desired speed is very small, then the function checks to see if there are targets (calculateTargetAlignmentAngle) to face.
|
protectedvirtual |
Computes the desired heading when there isn't a position or velocity goal input.
If the current speed is > the maxSpeedForHeadingControl, then the heading is just the direction of velocity. Otherwise, if there is a heading control input, that is the heading. Otherwise, if there is a target, then it's bearing is the heading. Otherwise, the current heading is returned.
|
protectedvirtual |
Computes the desired topo acceleration and yaw acceleration for movement along a heading.
Ordered speed and altitude are followed.
|
protectedvirtual |
.................
Lands the entity if the fuel is used up.
|
protectedvirtual |
Given from and to positions in local coordinates, and a coordinate system, compute a delta position whose vertical component is the difference in altitudes of the from and to positions.
This will be a vector to follow around the curve of the earth, vs. a straight line in space between the positions. The length of the vector will not be accurate (neither straight line distance or around-the-earth distance, exactly) but it is assumed that the length is long enough to max out the control system anyway.
|
protectedvirtual |
Computes a limiting acceleration such that the forward speed of the entity does not exceed its max speed or ordered speed (ordered speed does not apply if the goal position has a velocity).
|
protectedvirtual |
Limit acceleration based on maxAcceleration and maxStoppingDeceleration parameter limits.
Argument horizBodyAccel is a vector containing the input (desired) acceleration with X aligned with the entity's heading and Y to the right. This vector is modified if limiting is required. (Z is not changed.)
|
protectedvirtual |
Computes the position error to the goal point in topo coordinates.
If the horizontal distance is > 5km, then the difference in altitudes is used for dz, rather than the difference in topo z coordinates of the current and goal points (to accommodate earth curvature).
|
protectedvirtual |
Determines the direction and magnitude of the velocity at the goal point.
If the velocity selector input is 0, then 0 speed is output, with a direction corresponding to the delta position.
|
protectedvirtual |
Computes an acceleration toward a goal point to reach it and be at the desired speed when it is reached.
Period is the time before the entity can begin decelerating, i.e. dT or some longer time if there is a delay before deceleration starts. The return maxAccelTowardGoal is the max acceleration that can be used and still hit the target point using max-deceleration.
|
protectedvirtual |
This function is used when moving to a position, and with the continue flag port set true.
In this case, the acceleration (an in-out parameter) is limited to keep the horizontal speed low enough that the altitude goal is reached when the horizontal position is reached.
|
protectedvirtual |
Determines the acceleration to use in the direction perpendicular to a line that goes through the desired end point and is aligned with the goal velocity direction.
|
protectedvirtual |
Compute the desired z acceleration (up) from the given delta Z.
Z is from topo coordinates, so is positive if the goal is below the entity altitude. Includes a check for terrain and insertion of upward velocity for terrain avoidance. The value returned in desiredZAccel is in topo coordinates, so is positive if the acceleration is down.
|
protectedvirtual |
Compute and return a value of acceleration such that the entity can use that acceleration for one period (tick), and then decelerate at up to maxDecel for an integral number of periods, and just reach a moving target point (targetDist -> 0) when it hits the target's speed.
If targetDist < 0, then the function looks for a solution that involves decelerating for one period and then accelerating at up to maxAccel for an integral number of periods. If no solution can be found, then the function uses a PD control calculation to produce an acceleration (based on making targetDist = 0). This function is used to produce an acceleration for movement horizontally toward a goal point, movement toward a line through the goal point that is aligned with the desired velocity, moving vertically to a desired altitude, and orienting to a desired heading.
|
protectedvirtual |
True if the horizontal distance to the goal position is less than a body length.
Within this distance, the pilot does not try to orient towards the goal point, but just translates the entity without changing the heading to get exactly to the goal.
|
protectedvirtual |
Sets the collective and collective from a desired acceleration input.
The acceleration is a topographic acceleration oriented to the entity heading, i.e. X is the horizontal acceleration in the heading of the entity, Y is the horizontal acceleration to the right of the heading of the entity, and Z is the down acceleration. Note that Z must include acceleration for counteracting gravity; i.e. if Z = -G, the entity will not accelerate up or down.
These values will be converted to values between -1 and 1 (each axis of cyclic) or 0 and 1 (collective) based on the entity max-acceleration and max-climb rates. Side effect is the setting of the cyclic and collective ports.
|
protectedvirtual |
|
protectedvirtual |
Sets the throttle control output value.
|
protectedvirtual |
Calculate an upward desired velocity to maintain a safe distance from the terrain.
|
protectedvirtual |
Calculate the angle to the target position input (port), or if none any target in a weapon PSR.
This function is used when the entity is stationary and has 0 desired velocity.
|
protectedvirtual |
Computes a desired yaw acceleration to point the entity toward the given heading.
|
protectedvirtual |
Sets the myBodyToRef, myLocalToTopoDcm, and myTopoToLocalDcm.
|
inlineprotectedvirtual |
! Constants
When moving toward a goal point, how slow the point (i.e. desired velocity control input) has to be moving before being considered stationary. When the goal point is moving, if the entity is close to it it will orient to the direction of movement; if the point is stationary, the entity will just maintain a constant orientation as it moves toward the goal. In mps.
|
inlineprotectedvirtual |
When moving toward a moving goal, how much faster than the goal's speed the entity is allowed to move while it is approaching.
(If this is less than the ordered speed, the entity will move at ordered speed.)
Calculate the distance squared between the projections of the points onto the x-y plane.
Used by some other controllers.
|
protected |
Input Port Name: target-location
Input Port Description: Accepts local database location of a target which the pilot should orient the aircraft to face, in the absence of other tasks.
Input Port Range: Local database locations.
|
protected |
A pointer to the descriptor for this controller.
|
protected |
The local orientation matrix.
|
protected |
The local to topographic coordinate transformation matrix.
|
protected |
The topographic to local coordinate transformation matrix.
|
protected |
The 2D rotation about the yaw axis only.