VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtFixedWingMoveAlongController Class Reference

DtFixedWingMoveAlongController is a controller that models the movement of a fixed wing entity along a route. More...

Inheritance diagram for DtFixedWingMoveAlongController:
Inheritance graph
[legend]

Public Member Functions

 DtFixedWingMoveAlongController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingMoveAlongController ()
 destructor
virtual void preFirstTickInit ()
 If tasked and if the process state has a route name, setupRoute is called.
virtual void tick ()
 Calculate new control values.
virtual DtString type () const
 Returns a string identifies the class type of component.
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 doLanding ()
 Checks to see if the entity is on the ground.
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 move passed the control point to which it is moving this frame if it continues at its current velocity and acceleration.
virtual void processFlyAlongTask (DtSimMessage *msg)
virtual void processMoveAlongTask (DtSimMessage *msg)
virtual void processRouteChanged (DtVrfObject *obj)
 Called when the route to which this entity is tasked is modified.
virtual void processSetAltitude (DtSimMessage *msg)
 In all of the process functions, if an altitude change occured, then the function redetermines the proper value for the movement status and any other state variables.
virtual void processSetLocation (DtSimMessage *msg)
virtual void processSetRestore (DtSimMessage *msg)
virtual void processModifyVrfObject (DtSimMessage *msg)
 If the entity is tasked, the route is valid, and the object moved was the entity, then this resets the current route state to the closest point on the route.
virtual void processDeleteVrfObject (DtVrfObject *msg)
 Makes sure to update the state of the controller appropriately if either the route or any other relevent vrfobject was deleted.
virtual bool setupRoute ()
virtual void registerTaskMsgCallbacks ()
 Overrides this so it can register it's interest in the radio messages defined above.
- 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)
 The following functions assume that the FWE is in the AIR.
virtual void flyToDirect (const DtVector &destination, double speed)
 Call this to fly to a specified 3D point at the given speed.
virtual void fly (double speed, double turnRate, double climbRate)
 Call this to fly at a given speed, turn rate and climb rate.
virtual void flyFixedPitch (double speed, double turnRate, double desiredPitch)
 Call this to fly at a given speed, turn rate and pitch.
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, and current acceleration.
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)
 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) 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)
 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 DtReal maxTurningGs () const
 Parameter value from descriptor.
virtual DtReal maxTurnRateCutoffAngle () const
 Parameter value from descriptor.
virtual DtReal maxTaxiingTurnSpeed () const
 Parameter value from descriptor.
virtual DtReal taxiingNearDistance () const
 Parameter value from descriptor.
virtual DtReal taxiingAtDistance () const
 Parameter value from descriptor.
virtual DtReal taxiingApproachSpeed () const
 Parameter value from descriptor.
virtual DtReal maxPitchAngle () const
 Parameter value from descriptor.
virtual DtReal timeToTargetAltitude () const
 Parameter value from descriptor.
- 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 taskComplete (bool success=true)
 If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
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 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< int > currentPendingSubstaskIds () 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 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 (DtSimBaseRadio *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 void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
 The current tasked state of this controller.
- 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 DtSimBaseRadioradio ()
 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 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 (FILE *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 DtFilename &searchPath, 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 bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStream & objectConsoleDebug () const
virtual DtOutputStream & objectConsoleVerbose () const
virtual DtOutputStream & objectConsoleInfo () const
virtual DtOutputStream & objectConsoleWarn () const
virtual DtOutputStream & objectConsoleError () 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static void moveAlongCallback (DtSimMessage *msg, void *usrData)
 Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of move-along tasks.
static void flyAlongCallback (DtSimMessage *msg, void *usrData)
static void routeChangedCallback (DtVrfObject *obj, void *usrData)
static void setAltitudeCallback (DtSimMessage *msg, void *usrData)
static void setLocationCallback (DtSimMessage *msg, void *usrData)
static void setRestoreCallback (DtSimMessage *msg, void *usrData)
static void modifyVrfObjectCallback (DtSimMessage *msg, void *usr)
static void deleteVrfObjectCallback (DtVrfObject *msg, void *usr)
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

 DtFixedWingMoveAlongController ()
 default constructor - should not be called
 DtFixedWingMoveAlongController (const DtFixedWingMoveAlongController &orig)
 copy constructor
DtFixedWingMoveAlongControlleroperator= (const DtFixedWingMoveAlongController &orig)
 assignment operator
void clearStoredRoute ()
 deletes the route currently stored.
void updateTakeOffDir ()
 Updates the take off direction vector in the process state repository by calculating the direction from the current location to the current route point.
void updateLandingDir ()
void processEntityLocationChange ()
 This function is meant to be called after the entity's location has been changed by the user.
virtual bool setMovementStatusFromRoute ()
 Looks at the current point in the route and the entity's position and determines which type of movement status is appropriate.
virtual void resetValues ()
 This method will clear out internal values for new calculations.
virtual void clearTask ()
 Calls resetValues.
- 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.
 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.

Protected Attributes

DtVrfObjectmyRoute
 This is looked up once per tick - assumed unchanging while we have control.
bool myRouteHasChanged
- 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.

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
- 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

DtFixedWingMoveAlongController is a controller that models the movement of a fixed wing entity along a route.

Developer Description: DtFixedWingMoveAlongController implements the move-along task for fixed-wing entities. It creates, in init(), a DtRouteState object (pointed to by the process state repository member myRouteState). This object is used by a DtRoute object to maintain the state of a route following task. All of its data and members are hidden from all but the DtRoute object; however, since it is created (and destroyed) by the controller, and not the DtRoute itself, it is possible for any number of controllers to follow the same DtRoute. DtFixedWingMoveAlongController overrides DtTaskControllerComponent:: registerTaskMsgCallbacks() and registers the callback function moveAlongCallback() for DtMoveAlongType radio messages.

Uses Descriptor Type: DtFixedWingPilotControllerDescriptor

Constructor & Destructor Documentation

DtFixedWingMoveAlongController::DtFixedWingMoveAlongController ( 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 DtFixedWingMoveAlongController::~DtFixedWingMoveAlongController ( )
virtual

destructor

DtFixedWingMoveAlongController::DtFixedWingMoveAlongController ( )
protected

default constructor - should not be called

DtFixedWingMoveAlongController::DtFixedWingMoveAlongController ( const DtFixedWingMoveAlongController orig)
protected

copy constructor

Member Function Documentation

virtual void DtFixedWingMoveAlongController::preFirstTickInit ( )
virtual

If tasked and if the process state has a route name, setupRoute is called.

If successful, a vertices changed callback is registered on myRoute with routeChangedCallback. The ordered altitude is set to the altitude of the current vertex in the route. Finally setMovementStatusFromRoute is called.

Reimplemented from DtSimComponent.

virtual void DtFixedWingMoveAlongController::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.

virtual DtString DtFixedWingMoveAlongController::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.

Returns
DtFixedWingMoveAlongControllerType

Reimplemented from DtFixedWingPilotController.

Reimplemented in DtFixedWingPatrolRouteController, and DtCruiseMissileMoveAlongController.

virtual void DtFixedWingMoveAlongController::doFinishing ( )
virtual

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

virtual void DtFixedWingMoveAlongController::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.

Reimplemented in DtFixedWingPatrolRouteController.

virtual void DtFixedWingMoveAlongController::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 if it has one.

Reimplemented in DtFixedWingPatrolRouteController.

virtual void DtFixedWingMoveAlongController::doMoving ( )
virtual

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

virtual void DtFixedWingMoveAlongController::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.

virtual void DtFixedWingMoveAlongController::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.

virtual void DtFixedWingMoveAlongController::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 DtFixedWingMoveAlongController::doLanding ( )
virtual

Checks to see if the entity is on the ground.

If so, it assumes that the entity has landed, updates the movement status, and calls makes sure the correct movement takes place. If not, then it creates the landing direction vector if it doesn't exist, ensures that the ordered altitude is set appropriately, and proceeds to fly towards the touch down point at the desired speed.

Reimplemented in DtFixedWingPatrolRouteController.

virtual double DtFixedWingMoveAlongController::findDesiredSpeed ( )
virtual

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

Flying - the ordered speed. For now, the ordered speed doesn't change whether approaching a goal or not. Taxiing - the ordered ground speed unless it is approaching the goal, at which point it will return the approach speed. Landing - the minimum lift speed Taking off - the maximum ground speed.

virtual bool DtFixedWingMoveAlongController::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 10 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 DtFixedWingMoveAlongController::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 DtFixedWingMoveAlongController::passedGoal ( )
virtual

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

If so, then it returns true.

static void DtFixedWingMoveAlongController::moveAlongCallback ( DtSimMessage msg,
void *  usrData 
)
static

Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of move-along tasks.

ASSUMPTION: All of these functions assume that the messages and the associated data are valid.

static void DtFixedWingMoveAlongController::flyAlongCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveAlongController::routeChangedCallback ( DtVrfObject obj,
void *  usrData 
)
static
static void DtFixedWingMoveAlongController::setAltitudeCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveAlongController::setLocationCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveAlongController::setRestoreCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtFixedWingMoveAlongController::modifyVrfObjectCallback ( DtSimMessage msg,
void *  usr 
)
static
static void DtFixedWingMoveAlongController::deleteVrfObjectCallback ( DtVrfObject msg,
void *  usr 
)
static
virtual void DtFixedWingMoveAlongController::processFlyAlongTask ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveAlongController::processMoveAlongTask ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveAlongController::processRouteChanged ( DtVrfObject obj)
virtual

Called when the route to which this entity is tasked is modified.

The function determines if the route change warrants updating the internal state and, if so, updates the internal state appropriately.

virtual void DtFixedWingMoveAlongController::processSetAltitude ( DtSimMessage msg)
virtual

In all of the process functions, if an altitude change occured, then the function redetermines the proper value for the movement status and any other state variables.

virtual void DtFixedWingMoveAlongController::processSetLocation ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveAlongController::processSetRestore ( DtSimMessage msg)
virtual
virtual void DtFixedWingMoveAlongController::processModifyVrfObject ( DtSimMessage msg)
virtual

If the entity is tasked, the route is valid, and the object moved was the entity, then this resets the current route state to the closest point on the route.

If the current movement status is taking off then it also resets the take off direction vector.

virtual void DtFixedWingMoveAlongController::processDeleteVrfObject ( DtVrfObject msg)
virtual

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

virtual bool DtFixedWingMoveAlongController::setupRoute ( )
virtual
virtual void DtFixedWingMoveAlongController::registerTaskMsgCallbacks ( )
virtual

Overrides this so it can register it's interest in the radio messages defined above.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtFixedWingPatrolRouteController.

static DtSimComponent* DtFixedWingMoveAlongController::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 DtFixedWingPatrolRouteController, and DtCruiseMissileMoveAlongController.

DtFixedWingMoveAlongController& DtFixedWingMoveAlongController::operator= ( const DtFixedWingMoveAlongController orig)
protected

assignment operator

void DtFixedWingMoveAlongController::clearStoredRoute ( )
protected

deletes the route currently stored.

void DtFixedWingMoveAlongController::updateTakeOffDir ( )
protected

Updates the take off direction vector in the process state repository by calculating the direction from the current location to the current route point.

void DtFixedWingMoveAlongController::updateLandingDir ( )
protected
void DtFixedWingMoveAlongController::processEntityLocationChange ( )
protected

This function is meant to be called after the entity's location has been changed by the user.

Usually this is through a setLocation, setAltitude, or drag and drop in the front end, but not necessarily. It resets the route state to the closest point in the route to the entity. Then it resets all necessary state including the ordered altitude and the current movement status. "Finishing" state is set to false and the lastDistanceSquared value is also reset.

virtual bool DtFixedWingMoveAlongController::setMovementStatusFromRoute ( )
protectedvirtual

Looks at the current point in the route and the entity's position and determines which type of movement status is appropriate.

NOTE: The following objects must be valid before this function can be called or its behavior is undefined:

  • myProcessState and myProcessState->routeState()
  • myFixedWingEntityState
  • simManager() && entity()->terrainAttachedTo() The movement status is set as follows: Entity Current Pt. in Rt. Movement Status on ground on ground taxi (only if there are no further points in the route or the next point is on the ground as well. on ground on ground take off (ONLY if next point in route is in the air) on ground in air take off in air on ground landing in air in air flying If the terrain data under each point in the route 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.

Reimplemented in DtCruiseMissileMoveAlongController.

virtual void DtFixedWingMoveAlongController::resetValues ( )
protectedvirtual

This method will clear out internal values for new calculations.

virtual void DtFixedWingMoveAlongController::clearTask ( )
protectedvirtual

Calls resetValues.

Reimplemented from DtFixedWingPilotController.

Member Data Documentation

DtVrfObject* DtFixedWingMoveAlongController::myRoute
protected

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

bool DtFixedWingMoveAlongController::myRouteHasChanged
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)