Public Member Functions |
| | DtSurfaceEntityFollowEntityController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString&,DtVrfObject*,DtSimManager*,
|
| virtual | ~DtSurfaceEntityFollowEntityController () |
| | Destructor.
|
| virtual DtString | type () const |
| | Returns a string identifies the class type of component.
|
| virtual bool | init () |
| | Calls down to the base class and then caches a pointer to the state repository in mySurfaceEntityState.
|
| virtual void | processFollowEntityTask (DtSimMessage *msg) |
| | Retrieves the entity to follow and offset from the task message.
|
| virtual void | registerTaskMsgCallbacks () |
| | Registers interest in follow entity tasks by calling addTaskProcessorCallback with followEntityCallback as the function pointer, and the 'this' pointer as the user data.
|
| virtual void | tick () |
| | This gives the thread of control to the component.
|
| virtual void | clearTask () |
| | Calls down to the base class and then calls allowDeactivation() on mySurfaceControlPortGroup.
|
| virtual bool | createSurfaceControlPortGroup () |
| | Creates the surface control output port group.
|
| | 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 |
| |
|
| | 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.
|
| | 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.
|
| | 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 |
| | 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.
|
Protected Member Functions |
| virtual bool | setupControlPoint () |
| | Sets myControlPoint to the follow location.
|
| virtual void | controlMovement () |
| | Computes the acceleration and turn needed to follow the station.
|
| virtual void | moveTowardProjectedStationPosition (double distanceToStation, double approachDistance) |
| | For the case when the entity starts far away from the station.
|
| virtual void | moveBackToApproachPoint (bool onLeftSide, double approachDistance, double turnRadius) |
| | If the entity is too far in front of the station, or oriented in the opposite direction as the station is moving, then this function is called to move the entity back toward a point approachDistance behind the station and one turnRadius to the side.
|
| virtual void | turnToProjectedStationLine (bool isOnLeft, double radius, double distanceToSegment) |
| | Set the turn rate port (via turnAtspeed()) to move toward and then align with the line extending from the station in the given direction.
|
| virtual void | accelToCatchUp (double stationSpeed, double entitySpeed, double distanceBehindStation) |
| | Set the acceleration port to make the entity catch up to the (moving) station, decelerating to the station's speed just as it it reaches the station.
|
| virtual void | accelToDropBack (double stationSpeed, double entitySpeed, double distanceAheadOfStation, double distanceFromLine) |
| | Set the acceleration port to make the entity decelerate to a speed below the station's speed–possibly stopping for a time– before accelerating again to meet the (moving) station just as the station catches the entity.
|
| virtual void | turnAtSpeed (double desiredHeading, double desiredSpeed) |
| | Turn and go at the given speed.
|
| virtual bool | willOverrunPoint (double distanceAhead, double distanceFromLine, double entitySpeed, double turnRadius, double pointSpeed, double maxWaitTime) |
| | Test to see if the entity moving at entitySpeed, after decelerating at its max rate to a stop, will still be > maxWaitTime in front of a point that is distanceAhead behind the entity, traveling at pointSpeed.
|
| virtual double | calculateAcceleration (double desiredSpeed) |
| | Computes the acceleration needed to reach the given speed, based on the difference between current and desired speeds.
|
| virtual double | limitAcceleration (double desiredAcceleration, double desiredSpeed) |
| | Constrains the acceleration to maxes defined in the parameters and avoids more acceleration than is needed to get to the desired speed in dT.
|
| virtual bool | createPortGroups () |
| | Overridden to call createSurfaceControlPortGroup().
|
| virtual bool | createPorts () |
| | Overridden to call createThrottlePort() and createRudderPort().
|
| 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 embarked and the target of the current movement task is not embarked on the same object return true, and otherwise return a call to the base class.
|
| | DtSurfaceEntityFollowEntityController () |
| | Default constructor; not implemented.
|
| | DtSurfaceEntityFollowEntityController (const DtSurfaceEntityFollowEntityController &orig) |
| | copy constructor; not implemented
|
const
DtSurfaceEntityFollowEntityController & | operator= (const DtSurfaceEntityFollowEntityController &orig) |
| | assignment operator; not implemented
|
| virtual void | clearPendingSubtasks () |
| | Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
|
| virtual void | clearSubtasksByType (const DtSimTaskMessageType &taskType) |
| | Clear all subtasks of a given type.
|
| virtual void | 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.
|
| | DtControllerComponent () |
| | default constructor
|
| | DtControllerComponent (const DtControllerComponent &orig) |
| | copy constructor
|
| const DtControllerComponent & | operator= (const DtControllerComponent &orig) |
| | assignment operator
|
| bool | testInvariant () const |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| | Copies values from the specified DtReaderWriter.
|
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| | Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
|
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| | Deriving class overrides these to get/put class specific data.
|
Public Member Functions inherited from DtSingleTaskControllerComponent