 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
DtSurfaceEntityPatrolRouteController is a controller that models patrolling along a route for surface entities. More...
Public Member Functions | |
| DtSurfaceEntityPatrolRouteController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtSurfaceEntityPatrolRouteController () |
| destructor | |
| virtual DtString | type () const |
| Returns a string identifies the class type of component. | |
| virtual void | processPatrolRouteTask (DtSimMessage *msg) |
| Retrives the name of the route for the patrol from the task message. | |
| virtual void | registerTaskMsgCallbacks () |
| Registers interest in patrol tasks by calling addTaskProcessorCallback with patrolRouteCallback as the function pointer, and the 'this' pointer as the user data. | |
| virtual void | moveToMiddleOrFinalPoint () |
| Overridden to call sailTo, preventing the base class from using a driftTo which would cause the entity to stop. | |
| virtual bool | targetNextVertex () |
| Overridden to continually loop route state. | |
 Public Member Functions inherited from DtSurfaceEntityMoveAlongController | |
| DtSurfaceEntityMoveAlongController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtSurfaceEntityMoveAlongController () |
| Destructor. | |
| virtual bool | init () |
| Calls the parent init, then registers the attribute provider functions. | |
| virtual void | clearTask () |
| Calls down to the base class and then calls allowDeactivation() on mySurfaceControlPortGroup. | |
| virtual void | processMoveAlongTask (DtSimMessage *msg) |
| Retrives the route name from the task message. | |
| virtual void | processRouteChanged (DtVrfObject *obj) |
| Handles changes to the verticies in the route. | |
| virtual bool | atGoal () |
| Overridden to head to the next vertex in the route every time a vertex is reached until the end of the route is reached. | |
| virtual bool | passedGoal () |
| Overridden to head to the next vertex in the route every time a vertex is reached until the end of the route is reached. | |
| Public Member Functions inherited from DtSurfaceEntityMoveToLocationController | |
| DtSurfaceEntityMoveToLocationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtSurfaceEntityMoveToLocationController () |
| destructor | |
| virtual void | processMoveToLocationTask (DtSimMessage *msg) |
| Retrieves the move to location from the task message. | |
| virtual void | initializeLocals (const DtVector &globalTarget) |
| Initialize local variables and PSR data with the parameters of the task. | |
| virtual void | tick () |
| Overridden to check for valid myProcessState pointer. | |
| Public Member Functions inherited from DtSurfaceEntityPilotController | |
| DtSurfaceEntityPilotController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtSurfaceEntityPilotController () |
| Destructor. | |
| virtual bool | createSurfaceControlPortGroup () |
| Creates the surface control output port group. | |
| 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 void | suspendTask () |
| This method is called when the currently running task is being suspended. | |
| virtual int | sendSubtask (DtSimTask &task) |
| Sends subtask to ourself. | |
| virtual void | clearSubtask (int subtaskId) |
| Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). | |
| virtual void | addPendingSubtaskId (int subtaskId) |
| Adds given subtask Id to list of pending subtasks. | |
| virtual bool | findPendingSubtaskId (int subtaskId) |
| Checks to see if given subtaskId exists in our list of pending subtasks. | |
| virtual 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 DtTaskMessage * | currentTaskMessage () 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 DtSuspendedTaskInfo * | suspendTaskById (int taskId) |
| virtual std::list < DtTaskMessage * > | currentTaskMessages () const |
| | |
| virtual DtTaskWithTaskStateListPtr | topLevelTasks () const |
| | |
| Public Member Functions inherited from DtTaskControllerComponent | |
| DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString& name, | |
| virtual | ~DtTaskControllerComponent () |
| destructor | |
| virtual bool | showCurrentTaskInGui () const |
| virtual void | setRadio (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 DtSimBaseRadio * | radio () |
| The radio this component is listening to. | |
| Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () |
| destructor | |
| void | setParentSystem (DtComponentSystem *system) |
| Sets the parent system of this component. | |
| virtual void | registerAttributeFunctions () |
| Called to register functions that provide system attribute values. | |
| virtual void | preFirstTickInit () |
| This function can be overridden to initialize a component before it is ticked for the first time. | |
| virtual void | timedTick () |
| This version of tick checks to see if the time to tick has arrived. | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as | |
| virtual double | minTickPeriod () const |
| access the minimum tick period | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. | |
| virtual double | nextTickTime () const |
| access the next tick time | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. | |
| virtual double | calculateFirstTickTime () const |
| Returns the first time value that the component should tick at. | |
| virtual void | setEntity (DtVrfObject *entity) |
| The entity's state repository is the place that actuator components make updates and other components look to see our current state. | |
| virtual DtSimComponent * | nextComponent () |
| List management functions. | |
| virtual DtSimComponent * | prevComponent () |
| 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 DtInputPort * | lookupInputPort (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 DtOutputPort * | lookupOutputPort (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 DtInputPortGroup * | lookupInputPortGroup (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 DtOutputPortGroup * | lookupOutputPortGroup (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. | |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual DtString | componentFullName () const |
| virtual DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. | |
| virtual const DtPhysicalWorld * | physicalWorld () const |
| virtual DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. | |
| virtual const DtAttachedTerrain * | terrainAttachedTo () const |
| virtual DtVrfObject * | entity () |
| Gets the entity. | |
| virtual const DtVrfObject * | entity () const |
| virtual DtSimManager * | simManager () |
| Gets the sim manager. | |
| virtual const DtSimManager * | simManager () const |
| virtual const Coordinate_System * | coordinateSystem () const |
| Gets the coordinate system, as it should always exist if the physical world is in a valid state! | |
| virtual Coordinate_System * | coordinateSystem () |
| virtual DtVrfObjectStateRepository * | localStateRepository () |
| Gets the local state repository. | |
| virtual const DtVrfObjectStateRepository * | localStateRepository () 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 DtSimResourceManager & | resourceManager () |
| 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 DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | 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 aliasContainer & | aliases () 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 void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| static void | patrolRouteCallback (DtSimMessage *msg, void *usrData) |
| Called when a patrol route message is received. | |
| Static Public Member Functions inherited from DtSurfaceEntityMoveAlongController | |
| static void | moveAlongCallback (DtSimMessage *msg, void *usr) |
| Called when a move along message is received. | |
| static void | routeChangedCallback (DtVrfObject *obj, void *user) |
| Calls processRouteChanged(). | |
| static void | objectAboutToBeRemovedCallback (DtVrfObject *obj, void *usr) |
| static DtReaderWriter * | provideCurrentMinTurnRadius (void *controller) |
| Attribute access functions. | |
| static DtReaderWriter * | provideTurnRadiusForOrderedSpeed (void *controller) |
| Provides the turn-radius-for-ordered-speed attribute for the surface entity movement system. | |
| static DtReaderWriter * | provideNextRoutePointIndex (void *controller) |
| Provides the index of the route point the entity is moving towards. | |
| Static Public Member Functions inherited from DtSurfaceEntityMoveToLocationController | |
| static void | moveToLocationCallback (DtSimMessage *msg, void *usr) |
| Called when a move to location message is received. | |
| Static Public Member Functions inherited from DtSurfaceEntityPilotController | |
| static DtReaderWriter * | provideOrderedSpeed (void *controller) |
| Attribute access functions. | |
Protected Member Functions | |
| DtSurfaceEntityPatrolRouteController () | |
| Default constructor; not implemented. | |
| DtSurfaceEntityPatrolRouteController (const DtSurfaceEntityPatrolRouteController &orig) | |
| copy constructor; not implemented | |
| const DtSurfaceEntityPatrolRouteController & | operator= (const DtSurfaceEntityPatrolRouteController &orig) |
| assignment operator; not implemented | |
| Protected Member Functions inherited from DtSurfaceEntityMoveAlongController | |
| DtSurfaceEntityMoveAlongController () | |
| default constructor; not implemented | |
| DtSurfaceEntityMoveAlongController (const DtSurfaceEntityMoveAlongController &orig) | |
| copy constructor; not implemented | |
| const DtSurfaceEntityMoveAlongController & | operator= (const DtSurfaceEntityMoveAlongController &orig) |
| assignment operator; not implemented | |
| virtual DtVector * | getNextRoutePoint (int &index) |
| Determines the next point along the route to use. | |
| virtual DtVector | previousRoutePoint () |
| Gets the previous route point, before the current aim point; used for computing the route direction to the aim point. | |
| virtual void | setStateForCurrentPoint () |
| Set up Process State for current route point. | |
| virtual bool | setupControlPoint () |
| Makes sure the route state is valid (in case this is the first tick since a scenario load). | |
| virtual void | controlMovement () |
| Executes the control function for the task, to produce control port outputs. | |
| virtual bool | shouldMoveToRouteSegment (double &distanceToSegment, DtVector2D &unitRoute) |
| Tests the current position and orientation of the entity with respect to the current route segment (i.e., the direct line between the last route point and the current target route point) to determine if the entity should make some special maneuvers to move onto the route segment rather than just heading toward the target route point. | |
| virtual void | controlMovementToRouteSegment (double distanceToSegmenet, DtVector2D &unitRoute) |
| Controls the entity to move it toward the current route segment. | |
| virtual DtReal | computeStartTurnDistance2 () |
| Computes how far before the next control point the ship has to start turning toward the following route point to keep the ship close to the route without overshooting the control point. | |
| virtual DtReal | minTurnRadiusForSpeed (double speed) const |
| Compute the minimum turn radius based on given speed, normal lateral acceleration, and minimum turn radius parameter. | |
| virtual DtVrfMovingObjectStateRepository * | getSR () |
| Gets the entity state repository for purposes of providing attributes. | |
| virtual DtSurfaceMovementPSR * | getPSR () |
| Gets the process state repository for purposes of providing attributes. | |
| virtual void | emptyVertexList () |
| Removes and deletes vertices from the vertex list in process state repository (calls process state repository's emptyRouteVertices()). | |
| virtual void | processObjectAboutToBeRemoved (DtVrfObject *obj) |
| Ends the task if the route object is removed. | |
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 |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| Protected Types inherited from DtTaskControllerComponent | |
| typedef std::pair < DtTaskMessageCallbackFcn, void * > | DtTaskCallbackMapPair |
| This map stores callbacks that have been registered to processes various tasks. | |
| typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair > | DtTaskCallbackMap |
| Protected Attributes inherited from DtSurfaceEntityMoveAlongController | |
| double | myMinManeuverDistance2 |
| Caches a threshold distance inside of which the entity will not consider moving to the route line, vs. | |
| Static Protected Attributes inherited from DtSimComponent | |
| static DtSimComponentFactory * | myFactory |
DtSurfaceEntityPatrolRouteController is a controller that models patrolling along a route for surface entities.
End User Description:
DtSurfaceEntityPatrolRouteController (surfEntPtrlRt.h) is derived from DtSurfaceEntityMoveAlongController. It changes the functionality of DtSurfaceEntityMoveAlongController from Move Along Route to Patrol Along Route by modifying the route state when the end of a route is reached, instead of completing the task. DtSurfaceEntityPatrolRouteController adds uses the reverse flag from the process state repository to keep track of the direction in which the route is being followed. It overrides registerTaskMsgCallbacks() to register for DtPatrolRouteType. By overriding doMoving(), the controller can insure that sailTo() is always called (as opposed to the base class which calls driftTo() at the end of the route). Overriding targetNextVertex() allows continuous iteration back and forth through the vertices, and maintains the reverse flag.
Uses Descriptor Type: DtSurfaceEntityPilotControllerDescriptor
| DtSurfaceEntityPatrolRouteController::DtSurfaceEntityPatrolRouteController | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
(const DtString&,DtVrfObject*,DtSimManager*,
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
|
virtual |
destructor
|
protected |
Default constructor; not implemented.
|
protected |
copy constructor; not implemented
|
static |
(const DtString&,DtVrfObject*,DtSimManager*,
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
Reimplemented from DtSurfaceEntityMoveAlongController.
|
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.
Reimplemented from DtSurfaceEntityMoveAlongController.
|
static |
Called when a patrol route message is received.
Instances of this component will register this callback in registerTaskMsgCallbacks (with their own 'this' pointer as user data) by calling addTaskProcessorCallback in order to request for notification of patrol route tasks. When this callback is activated, the user data pointer is cast to an instance of this class upon which processPatrolRouteTask is called with the patrol route task message.
|
virtual |
Retrives the name of the route for the patrol from the task message.
Called by patrolRouteCallback to store the names of the route in the process state repository. The reverse flag in the PSR is reset to false. The route is lookup up in the object manager and a pointer to it is stored in myRoute. The route verticies are then copied in the route state in the process state repository and setToClosest is called on the PSR with the location of the entity. A verticesChangedCallback is added on the route with routeChangedCallback as the function pointer. The myRouteHasChanged flag is set to false. A call is made to setupControlPoint() to initilize the base class.
|
virtual |
Registers interest in patrol tasks by calling addTaskProcessorCallback with patrolRouteCallback as the function pointer, and the 'this' pointer as the user data.
Reimplemented from DtSurfaceEntityMoveAlongController.
|
virtual |
Overridden to call sailTo, preventing the base class from using a driftTo which would cause the entity to stop.
virtual void doMoving(double desiredSpeed); Overrides the parent function; always moves to the next point at ordered speed, even if the final point.
Reimplemented from DtSurfaceEntityMoveAlongController.
|
virtual |
Overridden to continually loop route state.
Checks to see if the current vertex in the route state (from the process state repository) is the last vertex in the route. If so the reverse flag is flipped, and the route state is reset. Once the route state is upddated, next() is called to advance to the next vertex, setupControlPoint() is called to initilize the base class and doMoving() is called with findDesiredSpeed().
Reimplemented from DtSurfaceEntityMoveAlongController.
|
protected |
assignment operator; not implemented