VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtFixedWingMoveToController Class Reference

DtFixedWingMoveToController is a controller used to model the movement of a fixed wing entity to a specific waypoint. More...

Inheritance diagram for DtFixedWingMoveToController:
Inheritance graph
[legend]

Public Member Functions

 DtFixedWingMoveToController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingMoveToController ()
 destructor
virtual void tick ()
 Calculate new control values.
virtual const chartype () const
 Returns a string identifies the class type of component.
bool setMovementStatusFromControlPoint ()
 Looks at the control point and the entity and determines which type of move to case is appropriate.
virtual void doFinishing ()
 Based on the current Movement status of the entity, calls the appropriate doFinishing function.
virtual void doFinishingForFlying ()
 Checks to see if the entity is within two seconds of being at the waypoint, or if the entity’s distance from the waypoint is greater than it was the previous frame (by comparing myProcessState->distanceSquared() to myProcessState->lastDistanceSquared()).
virtual void doFinishingForTaxiing ()
 Only called if the entity is near its goal.
virtual void doMoving ()
 Determines what state the entity is currently in and then calls the appropriate doMoving function for that state.
virtual void doFlying ()
 Determines if the entity is five seconds or fewer away from being at the waypoint using the entity’s speed and myDistanceSquared.
virtual void doTaxiing ()
 Determines if the entity is near its goal.
virtual void doTakeOff ()
 Changes the ordered speed to be the max ground speed and then taxi's in the direction of the waypoint.
virtual void updateTakeOffDirection ()
 Calculates and sets a new direction vector using the current waypoint to move to and the current position of the entity.
virtual double findDesiredSpeed ()
 This function returns the appropriate speed for the movement status of the FWE.
virtual bool nearGoal ()
 Determines if the entity is close enough to the waypoint that it can be considered near its goal.
virtual bool atGoal ()
 Determines if the entity is "at" the goal.
virtual bool passedGoal ()
 Determines if the entity will taxi passed the control point to which it is moving this frame if it continues at its current velocity and acceleration.
virtual void taskComplete (bool success=true)
 Overridden to set all internal state (i.e.
virtual void processMoveToTask (DtSimMessage *msg)
 Callback functions to execute when messages registered for are received.
virtual void processMoveToAltitudeTask (DtSimMessage *msg)
virtual void processSetAltitude (DtSimMessage *msg)
 Changes the entities altitude/position to the user specified value.
virtual void processSetLocation (DtSimMessage *msg)
virtual void processSetRestore (DtSimMessage *msg)
virtual void processWaypointChanged (DtVrfObject *msg)
virtual void processModifyVrfObject (DtSimMessage *msg)
 If the entity is tasked, the control point is valid, and the object moved was the entity, then this resets any state associated with the previous location of the FWE when the location of the entity to which this controller is attached is changed through a DtIfModifyVrfObject message (i.e.
virtual void processDeleteVrfObject (DtVrfObject *msg)
 Makes sure to update the state of the controller appropriately if either the waypoint or any other relevent vrfobject was deleted.
virtual bool createWorkingControlPoint (const DtVector location)
 Creates a new "phantom" waypoint at the current location of the FWE, but at an altitude specified by the MoveToAltitude task.
virtual void registerTaskMsgCallbacks ()
 Overrides this so it can register its interest in MoveTo commands and all other messages described in the above functions.
- Public Member Functions inherited from DtFixedWingPilotController
 DtFixedWingPilotController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingPilotController ()
 destructor
virtual bool init ()
 Initializes myFixedWingEntityState.
virtual void taxiTo (const DtVector &destination, double speed)
 The following functions assume that the FWE is on the GROUND.
virtual void taxi (double speed, double turnRate)
 Call this to taxi at a given speed and turn rate.
virtual double calculateSteering (double turnAngle) const
 Calculates the pedal port value for the given turn angle.
virtual double approximateThrottle (double speed)
 Calculates the throttle port value for the given speed using: throttle = (slope/maxSlope + ((desiredSpeed/maxSpeed))
virtual double calculateCurrentBrakingDistance () const
 Returns the braking distance using the current speed and breaking ability to determine how long it would take to brake.
virtual void flyTo (const DtVector &destination, double speed, double maxTerrainAvoidanceLookaheadDist=-1)
 The following functions assume that the FWE is in the AIR.
virtual void flyToDirect (const DtVector &destination, double speed, double maxTerrainAvoidanceLookaheadDist=-1)
 Call this to fly to a specified 3D point at the given speed.
virtual void fly (double speed, double turnRate, double climbRate, double maxTerrainAvoidanceLookaheadDist=-1)
 Call this to fly at a given speed, turn rate and climb rate.
virtual void flyFixedPitch (double speed, double turnRate, double desiredPitch, double maxTerrainAvoidanceLookaheadDist=-1)
 Call this to fly at a given speed, turn rate and pitch.
virtual double terrainAvoidancePitch (double speed, double desiredPitch, double maxTerrainAvoidanceLookaheadDist)
 Checks for upcoming terrain collision along the path defined by the current heading and desiredPitch and if found, returns a new pitch to avoid terrain collision.
virtual bool clearPathTo (const DtVector &localPosition)
 Checks if there is a clear path from the entity location to the specified location.
virtual void circle (const DtVector &center, double radius, double speed, double altitude, bool clockwise=true)
 Call this to fly in a circle.
virtual double calcControlForRoll (double rollRate)
 Calculates and returns the stickY value needed to achieve the desired roll rate.
virtual double calcControlForThrottle (double speed, bool &deployFlaps)
 Calculates a throttle value based on the entity's current speed, desired speed, desired body pitch rate, and current acceleration.
virtual double decelerationLimitedClimbRate (double altitudeError, double desiredSpeed, double finalClimbRate=0.0)
 Estimates a limited climb rate that the entity can command this tick that will allow it to level out when the altitude error has been reduced to zero.
virtual void calcControlForTurnAndClimb (double turnRate, double climbRate, double &stickX, double &pedal)
 The calcControlForTurnAndClimb() method determines the appropriate pitch angle to use to achieve the desired climb rate, then calls calccontrolForTurnAndPitch().
virtual void calcControlForTurnAndPitch (double turnRate, double desiredPitch, double &stickX, double &pedal, double rollRate=0.0)
 The calcControlForTurnAndClimb() method determines complementary stickX and pedal values to achieve a desired turn rate and climb rate.
virtual double calculateClimbRate (double altitude, double climbTime) const
 Calculates a climb rate to achieve the specified altitude in the climbTime specified.
virtual double calculateTurnRate (double turnAngle, double additionalTurnRate=0) const
 Determines the turn rate that will be used to change heading.
virtual double calculateRollAngle (double turnRate, double speed) const
 Calculates a roll angle for a turn based on the turn rate desired and the entity's current speed.
virtual double calculateRollRate (double rollAngle, double turnRate)
 Calculates a desired rate of roll based on the current roll and the desired roll angle.
virtual void calculateNormalizedBodyVelocity ()
 Put current velocity into body coordinates.
virtual void calculateLocalAngularVelocity ()
 The calculateLocalAngularVelocity() function calculates the entity’s current rate of heading change and stores the value in myProcessState's myLocalAngularVelocity member.
virtual void calculateSpeedRatioSquared ()
 Calculate the square of our current speed divided by our max speed.
virtual void initializeControllerForTick ()
 The initializeControllerForTick() function is called to recompute the entity's normalized body velocity, local angular velocity, and speed ratio squared.
virtual bool createFixedWingControlPortGroup ()
 These are called in init to create the ports used to communicate with the actuator.
virtual bool createThrottlePort ()
virtual bool createStickPort ()
virtual bool createPedalPort ()
virtual bool createBrakePort ()
virtual bool createFlapsDeployedPort ()
 This is not currently used.
virtual
DtConstrainedAnalogOutputPort
throttlePort ()
 These provide access to the ports.
virtual
DtConstrainedDualAxisAnalogOutputPort
stickPort ()
virtual
DtConstrainedAnalogOutputPort
pedalPort ()
virtual
DtConstrainedAnalogOutputPort
brakePort ()
virtual DtBooleanOutputPortflapsDeployedPort ()
virtual void setMaxThrustAcceleration (double maxThrustAcceleration)
 These are used to set values in the process state repository.
virtual void setTakeOffDir (const DtVector &takeOffDir)
 The direction vector for take off.
virtual const DtVectortakeOffDir () const
virtual double maxTurningGs () const
 This is a reference to the entity parameters, stored in the state repository.
virtual bool terrainAvoidanceEnabled ()
virtual double terrainAvoidanceLookaheadTime ()
virtual DtReal maxTurningGsForTask () const
 Parameter value from descriptor.
virtual DtReal maxTurnRateCutoffAngle () const
virtual DtReal maxTaxiingTurnSpeed () const
virtual DtReal taxiingNearDistance () const
virtual DtReal taxiingAtDistance () const
virtual DtReal taxiingApproachSpeed () const
virtual DtReal maxPitchAngle () const
virtual DtReal timeToTargetAltitude () const
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtSingleTaskControllerComponent ()
 destructor
virtual void postTick ()
 Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
virtual void taskNotify (const DtSimTask &task)
 This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void suspendTask ()
 This method is called when the currently running task is being suspended.
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself.
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked.
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component.
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks.
virtual std::vector< intcurrentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller.
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id.
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr currentTaskState () const
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual bool showCurrentTaskInGui () const
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
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.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
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.
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.
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.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
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.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
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.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
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.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
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.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
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.
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.
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.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component.
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component.
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 DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 original 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 &)
 Restores 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 void moveToCallback (DtSimMessage *msg, void *usr)
 Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of the appropriate tasks and setDataRequests.
static void moveToAltitudeCallback (DtSimMessage *msg, void *usr)
static void setAltitudeCallback (DtSimMessage *msg, void *usrData)
static void setLocationCallback (DtSimMessage *msg, void *usrData)
static void setRestoreCallback (DtSimMessage *msg, void *usrData)
static void waypointChangedCallback (DtVrfObject *msg, void *usr)
static void modifyVrfObjectCallback (DtSimMessage *msg, void *usr)
 Calls processModifyVrfObject.
static void deleteVrfObjectCallback (DtVrfObject *msg, void *usr)
 Callback for getting DtDeleteVrfObject messages.
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual void getLocalDestination (DtVector &local) const
virtual void getWorldDestination (DtVector &world) const
virtual double distanceSquaredToDestination (const DtVector &current) const
 Returns distance squared from destination point to current location.
virtual double distanceSquaredToDestination2D (const DtVector &current) const
virtual bool atAltitude (double desiredAltitude) const
virtual bool setupControlPoint ()
 Sets up initial information for where the fixed wing wants to move to.
virtual void deleteWorkingControlPoint ()
 Deletes myWorkingControlPoint and cleans up any necessary elements.
virtual void clearTask ()
 Override to set myControlPoint to NULL.
void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
- Protected Member Functions inherited from DtFixedWingPilotController
virtual bool createPorts ()
 Overridden to create the fixed wing ports.
virtual bool createPortGroups ()
 Overridden to create myFixedWingControlPortGroup.
virtual void lookupAndCacheProcessSR ()
 This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState.
virtual bool postAddComponentsInit ()
 Calls lookupAndCacheProcessSR(), to look up our process state repository after all of the components have been created and loaded.
virtual bool decideToGiveUpTask () const
 If the entity is attached and the target of the current task is not, give up on the task.
virtual void updateCurrentState ()
 Get the values of the current state at this sim time, integrating over the past dt.
 DtFixedWingPilotController ()
 default constructor; not implemented
 DtFixedWingPilotController (const DtFixedWingPilotController &orig)
 copy constructor; not implemented
const DtFixedWingPilotControlleroperator= (const DtFixedWingPilotController &orig)
 assignment operator; not implemented
- Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void clearPendingSubtasks ()
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType)
 Clear all subtasks of a given type.
virtual void cleanupInactiveSubtaskStatus ()
 Clears out subtask status entries that are either completed or canceled which were started by this controller.
- Protected Member Functions inherited from DtTaskControllerComponent
virtual void suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual DtSimTaskMessageType remapScriptId (const DtSimTaskMessageType &) const
 In case this is aliased, return the actual script id.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked.
- 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 Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtVrfObjectmyControlPoint
 This is looked up once per tick - assumed unchanging while we have control.
DtVrfObjectmyWorkingControlPoint
 Locally allocated waypoint for use in moving to an altitude.
bool myFirstTick
- Protected Attributes inherited from DtFixedWingPilotController
DtFixedWingEntityStateRepositorymyFixedWingEntityState
DtFixedWingFlightPSRmyProcessState
 Pointer to a process state repository used to store state data associated with this component.
DtOutputPortGroupmyFixedWingControlPortGroup
 Output Port Group Name: fixed-wing-control
Output Port Group Description:
DtConstrainedAnalogOutputPortmyThrottlePort
 Output Port Name: throttle
Output Port Description:
Output Port Range: 0.
DtConstrainedDualAxisAnalogOutputPortmyStickPort
 Output Port Name: stick
Output Port Description:
Output Port Range: X: -1.
DtConstrainedAnalogOutputPortmyPedalPort
 Output Port Name: pedal
Output Port Description:
Output Port Range: -1.
DtConstrainedAnalogOutputPortmyBrakePort
 Output Port Name: brake
Output Port Description:
Output Port Range: 0.
DtBooleanOutputPortmyFlapsDeployedPort
 Output Port Name: flaps
Output Port Description:
Output Port Range:
Output Port Default Value: true
Output Group Parent: fixed-wing-control.
DtVector myCurrentLocalPosition
 State variables updated for the current time.
DtVector myCurrentLocalVelocity
double myCurrentSpeed
DtDcm myCurrentOrientationMatrix
double myCurrentHeading
double myCurrentTopoPitch
double myCurrentTopoRoll
DtDcm myLocalToTopoDcm

Private Member Functions

 DtFixedWingMoveToController ()
 default constructor - should not be called
 DtFixedWingMoveToController (const DtFixedWingMoveToController &orig)
 copy constructor
DtFixedWingMoveToControlleroperator= (const DtFixedWingMoveToController &orig)
 assignment operator

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 Types inherited from DtTaskControllerComponent
typedef std::pair
< DtTaskMessageCallbackFcn,
void * > 
DtTaskCallbackMapPair
 This map stores callbacks that have been registered to processes various tasks.
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtFixedWingMoveToController is a controller used to model the movement of a fixed wing entity to a specific waypoint.

Uses Descriptor Type: DtFixedWingPilotControllerDescriptor

Constructor & Destructor Documentation

DtFixedWingMoveToController::DtFixedWingMoveToController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtFixedWingMoveToController::~DtFixedWingMoveToController ( )
virtual

destructor

DtFixedWingMoveToController::DtFixedWingMoveToController ( )
private

default constructor - should not be called

DtFixedWingMoveToController::DtFixedWingMoveToController ( const DtFixedWingMoveToController orig)
private

copy constructor

Member Function Documentation

virtual void DtFixedWingMoveToController::tick ( )
virtual

Calculate new control values.

If myWaitingToSetMovementStatus is set in myProcessState, then setMovementStatusFromRoute is called to see if the required terrain data is now available.

Reimplemented from DtFixedWingPilotController.

Reimplemented in DtFixedWingFollowEntityController.

virtual const char* DtFixedWingMoveToController::type ( ) const
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.

Returns
DtFixedWingMoveToControllerType

Reimplemented from DtFixedWingPilotController.

Reimplemented in DtFixedWingFlyIntoController, DtFixedWingFollowEntityController, DtFixedWingPatrolBetweenController, and DtFixedWingMoveToLocationController.

bool DtFixedWingMoveToController::setMovementStatusFromControlPoint ( )

Looks at the control point and the entity and determines which type of move to case is appropriate.

Either taxiing, take off, landing, or flight. NOTE: The following objects must be valid before this function can be called or it will fail:

  • myControlPoint
  • myFixedWingEntityState
  • simManager()
  • entity()->referenceFrame() If the terrain data under the control point is not available, myWaitingToSetMovementStatus in myProcessState is set to true, the movement state is left unchanged and false is returned. Otherwise the movement state is set as described above, myWaitingToSetMovementStatus is set to false and true is returned.
virtual void DtFixedWingMoveToController::doFinishing ( )
virtual

Based on the current Movement status of the entity, calls the appropriate doFinishing function.

Reimplemented in DtFixedWingPatrolBetweenController.

virtual void DtFixedWingMoveToController::doFinishingForFlying ( )
virtual

Checks to see if the entity is within two seconds of being at the waypoint, or if the entity’s distance from the waypoint is greater than it was the previous frame (by comparing myProcessState->distanceSquared() to myProcessState->lastDistanceSquared()).

If so, all port values are set to 0.0, myFinishing is set to false, and taskComplete() is called. Otherwise, flyTo() is called, and myProcessState->lastDistanceSquared() is set to myDistanceSquared.

virtual void DtFixedWingMoveToController::doFinishingForTaxiing ( )
virtual

Only called if the entity is near its goal.

Checks to see if the entity is at the goal or passed it. If so, then it stops. Otherwise, it continues to taxi, but at its approach speed.

virtual void DtFixedWingMoveToController::doMoving ( )
virtual

Determines what state the entity is currently in and then calls the appropriate doMoving function for that state.

Reimplemented in DtFixedWingFollowEntityController.

virtual void DtFixedWingMoveToController::doFlying ( )
virtual

Determines if the entity is five seconds or fewer away from being at the waypoint using the entity’s speed and myDistanceSquared.

If it is, it sets the myFinishing flag to true; The myProcessState->lastDistanceSquared() is set to myDistanceSquared. otherwise, it calls the flyTo() function provided by its parent class.

Reimplemented in DtFixedWingFlyIntoController, and DtFixedWingFollowEntityController.

virtual void DtFixedWingMoveToController::doTaxiing ( )
virtual

Determines if the entity is near its goal.

If it is, it sets the finishing flag to true. The myProcessState->lastDistanceSquared() is set to myDistanceSquared. Otherwise, it calls the taxiTo() function provided by its parent class.

Reimplemented in DtFixedWingFollowEntityController.

virtual void DtFixedWingMoveToController::doTakeOff ( )
virtual

Changes the ordered speed to be the max ground speed and then taxi's in the direction of the waypoint.

By setting the ordered speed to be the max ground speed, the plane will acclerate until either maxing out its speed or reaching min lift speed and taking off.

virtual void DtFixedWingMoveToController::updateTakeOffDirection ( )
virtual

Calculates and sets a new direction vector using the current waypoint to move to and the current position of the entity.

virtual double DtFixedWingMoveToController::findDesiredSpeed ( )
virtual

This function returns the appropriate speed for the movement status of the FWE.

The desired speed can change between flying, taxiing, taking off...

Reimplemented in DtFixedWingFollowEntityController.

virtual bool DtFixedWingMoveToController::nearGoal ( )
virtual

Determines if the entity is close enough to the waypoint that it can be considered near its goal.

For ground motion, this means determining if its breaking distance is greater than or equal to the specified near distance. For flying, this determines if the entity is within 5 seconds of the goal at current speed or orientation. NOTE: if the entity is not, but because it is at it's maximum altitude and the altitude is further above, it then determines if it is close enough to the goal as if that goal was at its altitude.

virtual bool DtFixedWingMoveToController::atGoal ( )
virtual

Determines if the entity is "at" the goal.

For taxiing, it determines if entity is within the specified at-distance. For flying, it basically performs the same calculation for closeness, including altitude conditions, as nearGoal(), but for within 2 seconds.

virtual bool DtFixedWingMoveToController::passedGoal ( )
virtual

Determines if the entity will taxi passed the control point to which it is moving this frame if it continues at its current velocity and acceleration.

It dead-reckons its position. It calculates the vector that points from the entity to the control point by subtracting the DtVector that represents the entity’s position from the one representing the control point’s position. It finds the dot product between this vector and the goal vector, If that dot product is greater than 0.0, the entity will pass the control point this tick if it does not stop.

virtual void DtFixedWingMoveToController::taskComplete ( bool  success = true)
virtual

Overridden to set all internal state (i.e.

port values, etc) properly when completing a task before notifying the task manager and actually making the task complete.

Reimplemented from DtSingleTaskControllerComponent.

static void DtFixedWingMoveToController::moveToCallback ( DtSimMessage msg,
void *  usr 
)
static

Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of the appropriate tasks and setDataRequests.

static void DtFixedWingMoveToController::moveToAltitudeCallback ( DtSimMessage msg,
void *  usr 
)
static
static void DtFixedWingMoveToController::setAltitudeCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveToController::setLocationCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveToController::setRestoreCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveToController::waypointChangedCallback ( DtVrfObject msg,
void *  usr 
)
static
static void DtFixedWingMoveToController::modifyVrfObjectCallback ( DtSimMessage msg,
void *  usr 
)
static

Calls processModifyVrfObject.

static void DtFixedWingMoveToController::deleteVrfObjectCallback ( DtVrfObject msg,
void *  usr 
)
static

Callback for getting DtDeleteVrfObject messages.

virtual void DtFixedWingMoveToController::processMoveToTask ( DtSimMessage msg)
virtual

Callback functions to execute when messages registered for are received.

virtual void DtFixedWingMoveToController::processMoveToAltitudeTask ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveToController::processSetAltitude ( DtSimMessage msg)
virtual

Changes the entities altitude/position to the user specified value.

As a side effect, redetermines the proper value for the movement status and any other state variables.

virtual void DtFixedWingMoveToController::processSetLocation ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveToController::processSetRestore ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveToController::processWaypointChanged ( DtVrfObject msg)
virtual

Reimplemented in DtFixedWingFlyIntoController.

virtual void DtFixedWingMoveToController::processModifyVrfObject ( DtSimMessage msg)
virtual

If the entity is tasked, the control point is valid, and the object moved was the entity, then this resets any state associated with the previous location of the FWE when the location of the entity to which this controller is attached is changed through a DtIfModifyVrfObject message (i.e.

a drag & drop in the front-end).

virtual void DtFixedWingMoveToController::processDeleteVrfObject ( DtVrfObject msg)
virtual

Makes sure to update the state of the controller appropriately if either the waypoint or any other relevent vrfobject was deleted.

virtual bool DtFixedWingMoveToController::createWorkingControlPoint ( const DtVector  location)
virtual

Creates a new "phantom" waypoint at the current location of the FWE, but at an altitude specified by the MoveToAltitude task.

It sets both myWorkingControlPoint and myControlPoint to the new control point. In order to ensure that the memory is cleaned up properly, myWorkingControlPoint is responsible for deleting the created CP.

virtual void DtFixedWingMoveToController::registerTaskMsgCallbacks ( )
virtual

Overrides this so it can register its interest in MoveTo commands and all other messages described in the above functions.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtFixedWingFollowEntityController, DtFixedWingPatrolBetweenController, DtFixedWingFlyIntoController, and DtFixedWingMoveToLocationController.

static DtSimComponent* DtFixedWingMoveToController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.

Reimplemented from DtFixedWingPilotController.

Reimplemented in DtFixedWingFollowEntityController, DtFixedWingFlyIntoController, DtFixedWingPatrolBetweenController, and DtFixedWingMoveToLocationController.

virtual void DtFixedWingMoveToController::getLocalDestination ( DtVector local) const
protectedvirtual
virtual void DtFixedWingMoveToController::getWorldDestination ( DtVector world) const
protectedvirtual
virtual double DtFixedWingMoveToController::distanceSquaredToDestination ( const DtVector current) const
protectedvirtual

Returns distance squared from destination point to current location.

Positions are all in local coordinates

virtual double DtFixedWingMoveToController::distanceSquaredToDestination2D ( const DtVector current) const
protectedvirtual
virtual bool DtFixedWingMoveToController::atAltitude ( double  desiredAltitude) const
protectedvirtual
Returns
True when the entity is considered at the altitude specified in the specified desired altitude. Considers being at the altitude to being within 33 meters of it.
virtual bool DtFixedWingMoveToController::setupControlPoint ( )
protectedvirtual

Sets up initial information for where the fixed wing wants to move to.

Must call setMovementStatusFromControlPoint() after setting initial conditions

Reimplemented in DtFixedWingFollowEntityController, and DtFixedWingMoveToLocationController.

virtual void DtFixedWingMoveToController::deleteWorkingControlPoint ( )
protectedvirtual

Deletes myWorkingControlPoint and cleans up any necessary elements.

virtual void DtFixedWingMoveToController::clearTask ( )
protectedvirtual

Override to set myControlPoint to NULL.

Reimplemented from DtFixedWingPilotController.

void DtFixedWingMoveToController::updateTaskVisualizations ( )
protectedvirtual

Called to update task visualizations after every tick.

Implemented by subclasses.

Reimplemented from DtSimComponent.

Reimplemented in DtFixedWingFollowEntityController.

DtFixedWingMoveToController& DtFixedWingMoveToController::operator= ( const DtFixedWingMoveToController orig)
private

assignment operator

Member Data Documentation

DtVrfObject* DtFixedWingMoveToController::myControlPoint
protected

This is looked up once per tick - assumed unchanging while we have control.

DtVrfObject* DtFixedWingMoveToController::myWorkingControlPoint
protected

Locally allocated waypoint for use in moving to an altitude.

bool DtFixedWingMoveToController::myFirstTick
protected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)