VR-Forces 4.10 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
DtGroundPatrolRouteController Class Reference

DtGroundPatrolRouteController is a controller that models patrolling along route behavior for ground vehicles. More...

Inheritance diagram for DtGroundPatrolRouteController:
Inheritance graph
[legend]

Public Member Functions

 DtGroundPatrolRouteController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtGroundPatrolRouteController ()
 destructor More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual DtSimTaskStatePtr currentTaskState () const
 
virtual void registerTaskMsgCallbacks ()
 Overrides this so it can register its interest in patrolRoute commands. More...
 
virtual void stop ()
 Overrides so we can call DtRoute::reset() to reverse our direction instead of actually stopping at the end of the route. More...
 
- Public Member Functions inherited from DtGroundMoveAlongControllerComponent
 DtGroundMoveAlongControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtGroundMoveAlongControllerComponent ()
 destructor More...
 
virtual bool init ()
 Registers the attribute function with the parent system. More...
 
virtual void preFirstTickInit ()
 Override to try and look up route if we start out with a move-along route task and if found register routeChangedCallback as a vertices changed callback. More...
 
virtual void tick ()
 If tasked and destinationIsInsideObstruction() but the current vertex in the route is not the last one, print a warning to the console, call setDestinationIsInsideObstruction(false) and then call stop(). More...
 
virtual void processRouteChanged (const DtVrfObject *obj)
 
virtual DtAutomotivePSRgetPSR ()
 Gets the process state repository for purposes of providing attributes. More...
 
virtual bool setupRoute ()
 Look up the route by name, and set myRoute if found. More...
 
virtual bool setupDestination ()
 Sets myControlPoint to the position of the route's current vertex. More...
 
virtual double findDesiredSpeed ()
 Overrides so the entity will slow down when coming to large turns in the route, but not slowdown/stop if the turn is small. More...
 
virtual DtAutoTransmissionGearEnum determineGearSetting ()
 Sets myProcessState->myCurrentGear to DtAutoGearReverse or DtAutoGearForward based on sign of orderedSpeed(). More...
 
virtual double findCosTurnAngle ()
 Returns the cos of the angle of the next turn in the route. More...
 
- Public Member Functions inherited from DtGroundMoveToDestinationControllerComponent
 DtGroundMoveToDestinationControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtGroundMoveToDestinationControllerComponent ()
 destructor More...
 
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 Overridden to cast and set our local pointer to the descriptor. More...
 
virtual void processSetLocation (DtSimMessage *msg)
 Resets the destination vector when the location of the entity to which this controller is attached is changed through a set location request. More...
 
virtual void processModifyVrfObject (DtSimMessage *msg)
 Resets the destination vector when the location of the entity to which this controller is attached is changed through a DtIfModifyVrfObject message (i.e. More...
 
virtual bool getDestination (DtVector &destination)
 getDestination() More...
 
virtual const DtVectordestinationVector () const
 Returns the current destination vector for the entity. More...
 
virtual double findDesiredHeading ()
 Determines the desired heading in the following manner: If the myNearDestination member variable is true (set by nearDestination()), the desired heading is in the opposite direction as the destination vector (described in setupDestinationVector()). More...
 
virtual bool nearDestination ()
 Determines if the entity is close enough to the destination that it should start slowing down (see findDesiredSpeed()). More...
 
virtual bool atDestination ()
 Are we within the at-distance parameter to the destination? If the myDistanceSquared member calculated in tick() is less than or equal to the square of the value provided in the at-distance parameter of the DtGroundMoveToDescriptor, atDestination() sets myAtDestination to true. More...
 
virtual bool passedDestination ()
 Determines if the entity will pass the destination to which it is moving this frame if it continues at its current velocity and acceleration. More...
 
virtual void doMoving ()
 Calls determineGearSetting(), findDesiredSpeed() and findDesiredHeading() and then sets port values based on those results. More...
 
- Public Member Functions inherited from DtGroundAutoControllerComponent
 DtGroundAutoControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtGroundAutoControllerComponent ()
 destructor More...
 
virtual double approximateThrottle (double desiredSpeed, double headingError=0.0)
 Pre- 4.1:approximateThrottle attempts to guess the throttle setting needed to make the automotive actuator produce the desired speed, given the current slope and soil. More...
 
virtual double headingErrorRequiringMinTurnRadius ()
 
virtual double calculateSteering (double currentHeading, double desiredHeading) const
 Computes a steering output [-1, 1] to steer from the current heading to the desired heading. More...
 
virtual double calculateCurrentBrakingDistance () const
 
virtual bool createAutomotiveControlPortGroup ()
 These are called in init to create the ports used to communicate with the actuator. More...
 
virtual bool createThrottlePort ()
 
virtual bool createSteeringPort ()
 
virtual bool createBrakePort ()
 
virtual bool createGearPort ()
 
virtual bool createParkingBrakePort ()
 
virtual
DtConstrainedAnalogOutputPort
throttlePort ()
 
virtual
DtConstrainedAnalogOutputPort
steeringPort ()
 
virtual
DtConstrainedAnalogOutputPort
brakePort ()
 
virtual
DtConstrainedIntegerOutputPort
gearPort ()
 
virtual DtBooleanOutputPortparkingBrakePort ()
 
virtual double decelerationSoilFactor () const
 
virtual double calcSteeringForTurnInPlace ()
 calcSteering() calculates steering values for executing either a pivot or a (reverse) k turn. More...
 
virtual double calcThrottleForTurnInPlace ()
 calcThrottle() calculates throttle values for executing either a pivot or a (reverse) k turn. More...
 
virtual double calcBrakeForTurnInPlace ()
 If the vehicle can pivot, 0.0 is returned and otherwise a call to calcBrakeForKTurn() is returned. More...
 
virtual int calcGearForTurnInPlace ()
 calcGear() determines the correct gear setting for executing either a pivot or (reverse) k turn. More...
 
virtual double calcSteeringForPivot ()
 calcSteeringForPivot() determines an appropriate steering value for executing a pivot turn. More...
 
virtual double calcThrottleForPivot ()
 calcThrottleForPivot() determines an appropriate throttle value for executing a pivot turn. More...
 
virtual double calcSteeringForKTurn ()
 If the entity can not pivot, then this method can be used to calculate a steering value for a (reverse) k turn. More...
 
virtual double calcThrottleForKTurn ()
 If the entity can not pivot, then this method can be used to calculate a throttle value for a (reverse) k turn. More...
 
virtual double calcBrakeForKTurn ()
 If kTurnReverseComplete() returns true but the entity is still moving backwards, this function sets the brakes to 1.0 until the entity comes to a complete stop. More...
 
virtual double findSpeedForKTurn ()
 If the entity is in the reverse phase of the k turn, the maximum reverse speed of the vehicle is returned. More...
 
virtual double findHeadingForKTurn ()
 If the entity is in the reverse phase of the k turn, kTurnReverseGoalHeading() is returned, otherwise headingToTurnTo() is returned. More...
 
virtual void setHeadingToTurnTo (double headingToTurnTo)
 Get/Set the heading we the entity has been tasked to turn to. More...
 
virtual double headingToTurnTo () const
 
virtual double calculateHeadingToTurnTo ()
 The heading to turn to given the current turn mode and heaading to turn to. More...
 
virtual void setTurnToMode (int headingToTurnTo)
 Get/Set the heading turn to mode (see setHeadingRequest.h for modes) More...
 
virtual int turnToMode () const
 
virtual void setKTurnReverseGoalHeading (double kTurnReverseGoalHeading)
 Get/Set the heading that is halfway between the original heading and the heading to turn to. More...
 
virtual double kTurnReverseGoalHeading () const
 
virtual void setKTurnReverseComplete (bool kTurnReverseComplete)
 Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading()) More...
 
virtual bool kTurnReverseComplete () const
 
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSingleTaskControllerComponent ()
 destructor More...
 
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)). More...
 
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task. More...
 
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. More...
 
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. More...
 
virtual void suspendTask ()
 This method is called when the currently running task is being suspended. More...
 
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself. More...
 
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...
 
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks. More...
 
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks. More...
 
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked. More...
 
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component. More...
 
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks. More...
 
virtual std::vector< intcurrentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller. More...
 
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id. More...
 
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity. More...
 
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true. More...
 
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared. More...
 
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type. More...
 
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller. More...
 
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller. More...
 
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
 
virtual DtSuspendedTaskInfosuspendSubtaskById (int taskId, int subtaskId)
 
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
virtual void disable ()
 Overridden to allow tasks controllers that can be disabled to call task complete. More...
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtTaskControllerComponent ()
 destructor More...
 
virtual bool showCurrentTaskInGui () const
 
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks. More...
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type. More...
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback. More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback(). More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback. More...
 
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks(). More...
 
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message. More...
 
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component. More...
 
virtual void setTasked (bool tasked)
 The current tasked state of this controller. More...
 
virtual bool tasked () const
 
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtControllerComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 The radio this component is listening to. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values. More...
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived. More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at. More...
 
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state. More...
 
virtual DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
virtual DtListItem * listItem ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored. More...
 
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it. More...
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it. More...
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it. More...
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it. More...
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. More...
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. More...
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component. More...
 
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe. More...
 
virtual void addVRLinkDeferredJob (const boost::function< void()> &callback)
 Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...
 
virtual 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 More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static void patrolRouteCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
 
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtGroundMoveAlongControllerComponent
static void moveAlongCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
 
static void routeChangedCallback (const DtVrfObject *obj, void *usr)
 Handle messages that may indicate the route we're following has changed. More...
 
static DtReaderWriterprovideNextRoutePointIndex (void *c)
 A callback to provide a controller attribute ("next-route-point-index") More...
 
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
static void objectAddedCb (const DtVrfObject *vrfObject, void *usr)
 Calls processObjectAdded(). More...
 
static void objectAboutToBeRemovedCallback (const DtVrfObject *obj, void *usr)
 
- Static Public Member Functions inherited from DtGroundMoveToDestinationControllerComponent
static void setLocationCallback (DtSimMessage *msg, void *usr)
 Calls processSetLocation. More...
 
static void modifyVrfObjectCallback (DtSimMessage *msg, void *usr)
 Calls processModifyVrfObject. More...
 
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtTaskControllerComponent
static void deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
 Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

virtual void processPatrolRoute (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)
 
 DtGroundPatrolRouteController ()
 Default constructor; should not be called. More...
 
 DtGroundPatrolRouteController (const DtGroundPatrolRouteController &orig)
 copy constructor; shallow; does not copy the ports. More...
 
const
DtGroundPatrolRouteController
operator= (const DtGroundPatrolRouteController &orig)
 assignment operator; see comments on copy constructor! More...
 
- Protected Member Functions inherited from DtGroundMoveAlongControllerComponent
virtual void processMoveAlong (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)
 
 DtGroundMoveAlongControllerComponent ()
 default constructor - should not be called More...
 
 DtGroundMoveAlongControllerComponent (const DtGroundMoveAlongControllerComponent &orig)
 copy constructor More...
 
DtGroundMoveAlongControllerComponentoperator= (const DtGroundMoveAlongControllerComponent &orig)
 assignment operator More...
 
virtual void buildLocalRoute ()
 builds the local copy of the route by copying myRoute's vertices to my local storage in process state repository: myVertices. More...
 
virtual void emptyVertexList ()
 removes and deletes vertices from the vertex list in process state repository (calls process state repository's emptyRouteVertices()). More...
 
virtual void processObjectAdded (const DtVrfObject *vrfObject)
 Checks given vrfObject against the route we're looking for. More...
 
virtual void clearTask ()
 Override to clear route name and route state data stored in myProcessState. More...
 
virtual bool decideToGiveUpTask () const
 Checks to see if destination is inside an obstruction. More...
 
virtual void processObjectAboutToBeRemoved (const DtVrfObject *obj)
 
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick. More...
 
virtual void processEstimatedTotCalculation ()
 calculate estimated tot More...
 
virtual bool createPorts ()
 Overridden to create the automotive ports. More...
 
- Protected Member Functions inherited from DtGroundMoveToDestinationControllerComponent
virtual void setupDestinationVector () const
 Sets up a vector from the current destination location to the entity's location to use in determining when/if the entity has passed its destination location. More...
 
virtual void invalidateDestinationVector () const
 Tells the component that any cached destination vector should be recalculated. More...
 
virtual double desiredHeadingFromDestination (const DtDcm &localToTopoDcm)
 Given the destination, calculate the heading needed to reach that point. More...
 
virtual void moveToDestination ()
 Attempts to move to the destination location. Override to provide movement functionality. More...
 
virtual double distanceToDestination () const
 
virtual bool createPortGroups ()
 Overridden to create myAutomotiveControlPortGroup. More...
 
virtual void setDestinationIsInsideObstruction (bool yesNo)
 Set whether or not current destination is inside an obstruction. More...
 
virtual bool destinationIsInsideObstruction () const
 Returns whether or not current destination is inside an obstruction. More...
 
virtual bool usingNavBot ()
 
virtual void useNavBotData ()
 Uses calculations from the navBot to control the entity or end the task. More...
 
virtual void updateNavBotDestination ()
 
virtual unsigned maxNumFailedPathAttempts () const
 Returns the maximum number of times this component will attempt to find a new destination when the desired destination is unreachable. More...
 
virtual bool findAlternateDestination ()
 Finds and sets up an alternate destination nearby the current destination in the case where we are unable to path to that destination. More...
 
virtual void processNavAreaChanged ()
 
DtVector localDestination () const
 
virtual void processNavigationInterfaceChanged (const DtVrfObject *)
 
- Protected Member Functions inherited from DtGroundAutoControllerComponent
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. More...
 
virtual bool postAddComponentsInit ()
 Calls lookupAndCacheProcessSR(), to look up our process state repository after all of the components have been created and loaded. More...
 
virtual DtSoilFactorscurrentSoilFactors () const
 
- 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. More...
 
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType)
 Clear all subtasks of a given type. More...
 
virtual void cleanupInactiveSubtaskStatus ()
 Clears out subtask status entries that are either completed or canceled which were started by this controller. More...
 
- 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. More...
 
virtual void suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...
 
virtual DtSimTaskMessageType remapScriptId (const DtSimTaskMessageType &) const
 In case this is aliased, return the actual script id. More...
 
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor More...
 
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor More...
 
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator More...
 
virtual void onRestore ()
 Override to iterate over the descriptor to see if there are any targetting control tables. More...
 
virtual void initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT. More...
 
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. More...
 
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component. More...
 
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization. More...
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name. More...
 
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

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. More...
 
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
 
- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
 
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
 
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
 
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
 
- Static Protected Member Functions inherited from DtGroundMoveToDestinationControllerComponent
static void navAreaChangedCallback (void *usr)
 
static void navigationInterfaceChanged (const DtVrfObject *, void *usr)
 
- Protected Attributes inherited from DtGroundMoveAlongControllerComponent
const DtVrfObjectmyRoute
 This is looked up once per tick - assumed unchanging while we have control. More...
 
bool myRouteHasChanged
 This gets set to true when a modifyRoute message for the route we're following is received. More...
 
bool myResetVertex
 
int myPreviousVertex
 
bool myNeedsDestinationSetupOnNextTick
 
DtVectorOutputPortmyCurrentVertexLocationOutputPort
 Output Port Name: current-vertex-location
Output Port Description: Specifies the current vertex location of the entity's route in local coordinates. More...
 
- Protected Attributes inherited from DtGroundMoveToDestinationControllerComponent
double myDistanceSquared
 
DtVector myLocalDestination
 
DtVector myWorldDestination
 
bool myHasIntermediateDestination
 
DtVector myIntermediateWorldDestination
 
DtVector myIntermediateLocalDestination
 
DtVector myDestinationVector
 
bool myDestinationVectorIsValid
 
double myCurrentSpeed
 
bool myAtDestination
 
bool myNearDestination
 
bool myPassedDestination
 
const DtGroundMoveToDescriptormyMoveToDescriptor
 
DtActiveBotNavInterfacemyNavInterface
 
bool myIgnoreNavData
 
bool myDestinationIsInsideObstruction
 
unsigned myNumFailedPathAttempts
 
const double DtEstimatedTotCalcInterval = 5.0
 Interval for estimated tot calculations. More...
 
bool myEstimatedTotCalcEnabled
 enabled flag for the tot calculations More...
 
double myEstimatedTotValue
 the tot value More...
 
double myEstimatedTotLastCalcTime
 used for tot calculation intervals More...
 
DtVector myEstimatedTotTextPos
 tot text position More...
 
DtCollisionInputPortmyCollisionAvoidancePort
 Input Port Name: potential-collision-info
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: collision-avoidance-control. More...
 
DtInputPortGroupmyCollisionAvoidancePortGroup
 Input Port Group Name: collision-avoidance-control
Input Port Group Description: More...
 
DtBooleanOutputPortmyClampToNavDataPort
 Output Port Name: clamp-to-nav-data
Output Port Description: When there is a failure to path plan due to unavailable terrain data, this port is used to tell the actuator to clamp to the nav data instead. More...
 
- Protected Attributes inherited from DtGroundAutoControllerComponent
DtGroundVehicleStateRepositorymyGroundVehicleState
 
DtAutomotivePSRmyProcessState
 Pointer to a process state repository used to store state data associated with this component. More...
 
double mySpeedLastTick
 For derivative control in approximateThrottle. More...
 
double myAccumulatedSpeedError
 For integral speed control. More...
 
double myMaxMinRadiusSpeed
 Caches the value sqrt(max lateral acceleration * min turn radius) for use in the approximateThrottle function. More...
 
DtConstrainedAnalogOutputPortmyThrottlePort
 Output Port Name: throttle
Output Port Description:
Output Port Range: 0. More...
 
DtConstrainedAnalogOutputPortmySteeringPort
 Output Port Name: steering
Output Port Description:
Output Port Range: -1.0 to 1.0
Output Port Default Value:
Output Group Parent: automotive-control. More...
 
DtConstrainedAnalogOutputPortmyBrakePort
 Output Port Name: brake
Output Port Description:
Output Port Range: 0. More...
 
DtConstrainedIntegerOutputPortmyGearPort
 Output Port Name: gear
Output Port Description:
Output Port Range:
Output Port Default Value:
Output Group Parent: automotive-control. More...
 
DtBooleanOutputPortmyParkingBrakePort
 Output Port Name: parking-brake
Output Port Description:
Output Port Default Value: True
Output Group Parent: automotive-control. More...
 
DtOutputPortGroupmyAutomotiveControlPortGroup
 Output Port Group Name: automotive-control
Output Port Group Description: Collection of control output for automotive entity movement controllers. More...
 
- Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap myTaskCallbackMap
 
std::list
< DtTaskProcessorCallbackInfo * > 
myTaskProcessorCallbackInfoList
 This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...
 
bool myTaskIsRunning
 
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myMinTickPeriod
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
double myDT
 
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

DtGroundPatrolRouteController is a controller that models patrolling along route behavior for ground vehicles.

End User Description: The route is followed until complete, then in reverse, then forward, etc., until the entity is retasked.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

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

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

destructor

DtGroundPatrolRouteController::DtGroundPatrolRouteController ( )
protected

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtGroundPatrolRouteController::DtGroundPatrolRouteController ( const DtGroundPatrolRouteController orig)
protected

copy constructor; shallow; does not copy the ports.

Member Function Documentation

virtual const char* DtGroundPatrolRouteController::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
DtGroundAutoPatrolRouteType

Reimplemented from DtGroundMoveAlongControllerComponent.

static void DtGroundPatrolRouteController::patrolRouteCallback ( DtSimMessage msg,
void *  usr,
DtSimTaskStatePtr  taskStatePtr 
)
static
virtual DtSimTaskStatePtr DtGroundPatrolRouteController::currentTaskState ( ) const
virtual
Returns
Current execution state of the task. At the base class level, returns 0. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented from DtGroundMoveAlongControllerComponent.

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

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).
Returns
New instance of this class.
virtual void DtGroundPatrolRouteController::registerTaskMsgCallbacks ( )
virtual

Overrides this so it can register its interest in patrolRoute commands.

Reimplemented from DtGroundMoveAlongControllerComponent.

virtual void DtGroundPatrolRouteController::stop ( )
virtual

Overrides so we can call DtRoute::reset() to reverse our direction instead of actually stopping at the end of the route.

Reimplemented from DtGroundMoveAlongControllerComponent.

virtual void DtGroundPatrolRouteController::processPatrolRoute ( const DtTaskMessage msg,
DtSimTaskStatePtr  taskStatePtr 
)
protectedvirtual
const DtGroundPatrolRouteController& DtGroundPatrolRouteController::operator= ( const DtGroundPatrolRouteController orig)
protected

assignment operator; see comments on copy constructor!


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)