Public Member Functions |
| | DtRoadMovementController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString&,DtVrfObject*,DtSimManager*,
|
| virtual | ~DtRoadMovementController () |
| | destructor
|
|
| virtual const char * | type () const |
| | Returns a string identifies the class type of component.
|
| virtual bool | init () |
| | Create and initialize our roadUpdater, roadObstructionFinder, roadPathFunctions (using the set functions below), myFrontOffset, myRearAxleOffset, and settings manager callback.
|
| virtual void | preFirstTickInit () |
| | Calls initializeCurrentState from the currentTaskMessage.
|
| virtual void | tick () |
| | Determines how the entity moves along the given path.Checks if entity has completed it's task.
|
| virtual void | clear () |
| virtual bool | tickWhileDestroyed () const |
| | Define tickWhileDestroyed because this controller acts as an actuator in the way it updates the position of the entity directly.
|
| virtual void | registerTaskMsgCallbacks () |
| | Overrides this so it can register it's interest in RailMoveAlong commands.
|
|
These set functions can be used or overridden to install derivatives of the support classes.
|
| virtual const DtRoadConstants * | roadConstants () |
| virtual void | setRoadConstants (const DtRoadConstants *rc) |
| | A new set of road constants can be set in a class derived from DtRoadConstansts; then set the pointer here with the value MyRoadConstants::instance()
|
| virtual DtRoadPathFunctions * | pathFunctions () |
| virtual void | setPathFunctions (DtRoadPathFunctions *pf) |
| virtual DtRoadDrivingLogic * | drivingLogic () |
| virtual void | setDrivingLogic (DtRoadDrivingLogic *dl) |
| virtual DtRoadObstructionFinder * | obstructionFinder () |
| virtual void | setObstructionFinder (DtRoadObstructionFinder *of) |
| | After creating a new obstFinder, call init() on it.
|
| virtual DtRoadMovementUpdater * | movementUpdater () |
| virtual void | setMovementUpdater (DtRoadMovementUpdater *u) |
| | After creating a new updater, call init(), setEntityState(), and setPSR() on the new updater.
|
|
virtual
DtRailMovementControllerPSR * | psr () |
virtual const
DtMovingObjectParameters * | objectParameters () |
virtual const
DtRoadMovementDescriptor * | descriptor () const |
|
| virtual bool | drivingOnLeftEnabled () const |
| virtual void | setCurrentMovementState (DtRailMovementState state) |
| virtual DtRailMovementState | currentMovementState () const |
| virtual DtRoadSegment * | currentRoadSegment () const |
| virtual void | setCurrentRoadSegment (DtRoadSegment *seg) |
| virtual double | frontOffset () const |
| | Distance from vehicle center to front edge.
|
| virtual void | setFrontOffset (const double o) |
| virtual double | rearAxleOffset () const |
| | Distance from vehicle center to reference position at the rear axle.
|
| virtual void | setRearAxleOffset (const double o) |
| virtual DtRailSegmentList * | pathList () |
| | Returns a pointer to our path list.
|
| virtual const DtRailSegmentList * | pathList () const |
| virtual DtRoadSegmentPart | roadSegmentPart () const |
| | Accessors for myRoadSegmentPart (entry curve, straight section, exit curve).
|
| virtual void | setRoadSegmentPart (const DtRoadSegmentPart s) |
|
| virtual void | updateTaskVisualizations () |
| | Creates visualizations for the path along the road, for areas on the being searched for cars, and for cars identified to be obstacles.
|
| virtual bool | findPointOnTerrain (const DtVector &worldLocation, DtVector &worldLocationOnTerrain) |
| | Finds the closest point on the terrain.
|
| virtual std::vector< DtVector > & | debugPoints () |
| | Accessor for the individual points representing obstacle vehicles.
|
virtual std::vector
< std::vector< DtVector > > & | debugBoxes () |
| | Accessor for the array of 4-point arrays representing areas where the controller is looking for obstacle vehicles.
|
|
| virtual const double | followSpeedFactor () const |
| double | getDistanceBehindConvoyTarget (DtVrfObject *convoyTgt) |
| virtual DtVrfObject * | getObjectFromObstruction (DtRailObstructionPtr &obs) |
| | 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 bool | isSubtasked () const |
| | Returns true if this controller is currently subtasked.
|
| virtual void | removePendingSubtaskId (int subtaskId) |
| | Removes pending subtask from list of subtasks for this component.
|
| virtual void | removeAllPendingSubtaskIds () |
| | Clear all pending subtasks from our list of subtasks.
|
| virtual std::vector< 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 bool | decideToGiveUpTask () const |
| | This function is used to determine if the controller should give up trying to execute the current task.
|
| 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 (DtSimRadio *radio) |
| | Calls registerTaskMsgCallbacks.
|
| virtual void | addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr) |
| | Adds a new function for processing the specified task type.
|
| virtual void | addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr) |
| | Deprecated form of addTaskProcessorCallback.
|
| virtual void | removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr) |
| | Undoes anything done by addTaskProcessorCallback().
|
| virtual void | removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr) |
| | Deprecated form of removeTaskProcessorCallback.
|
| virtual void | enable () |
| | Overridden to call registerTaskMsgCallbacks().
|
| virtual void | disable () |
| | Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
|
| virtual void | sendTaskCanceled (DtTaskMessage *taskMsg) |
| | Sends the task canceled report for the specified message.
|
| virtual bool | taskVisualizationsActive () const |
| | Returns true if task visualizations are currently active for this component.
|
| virtual void | setTasked (bool tasked) |
| | The current tasked state of this controller.
|
| virtual bool | tasked () const |
| | DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString& name,
|
| virtual | ~DtControllerComponent () |
| | destructor
|
| virtual DtSimRadio * | 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 bool | postAddComponentsInit () |
| | Called after all components have been created, initialized and added to the component manager.
|
| virtual void | registerAttributeFunctions () |
| | Called to register functions that provide system attribute values.
|
| 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 (std::string &fp, int indentLevel=0) |
| | putData writes our type, which is provided by the virtual type accessor of the deriving class.
|
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| | getData is just used to get us past the type in the data stream, since it's not actual stored.
|
| virtual void | addInputPort (DtInputPort *port) |
| | Adds this input port to the components input port list so that other components can look it up and attach to it.
|
| virtual void | removeInputPort (DtInputPort *port) |
| virtual 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 |
| 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 DtTaskVisualizationMap & | taskVisualizations () |
| | Returns the list of task visualizations for this component.
|
| virtual bool | taskVisualizationsEnabled () const |
| | Returns true if task visualizations are enabled for this component.
|
| virtual bool | isEnabled () |
| virtual void | setIsEnabled (bool yesNo) |
| virtual DtOutputStream & | objectConsoleDebug (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleVerbose (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleInfo (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleWarn (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleError (const DtString &channel="") const |
| virtual 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) |
| | pseudo-copy constructor
|
| | DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) |
| | DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) |
| | copy constructor
|
| 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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| | Top level call to write itself to file.
|
| virtual void | postPutSelf () |
| | Called after either version of put self (file or environment). Default is no-op.
|
| virtual void | prePutSelf () |
| | Called before either version of put self (file or environment). Default is no-op.
|
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| | Top level to read itself from an input stream.
|
| virtual void | postGetSelf () |
| | Called after either version of getSelf (mtl or environment). Default is no-op.
|
| virtual void | preGetSelf () |
| | Called before either version of get self (file or environment). Default is no-op.
|
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| | Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
|
| virtual DtSymbolString | name () const |
| | Accessor for name of this readable/writable object.
|
| virtual void | addAlias (const DtSymbolString &alias) |
| | Add an alias as an alternative name for this object.
|
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| | Set read-only flag.
|
| bool | isReadonly () const |
| virtual void | reset () |
| | For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
|
| virtual int | alignment () const |
| | For those items that are sent over the network via HLA, this will give the network alignment.
|
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| | Sets the myVariableIsBound flag to false.
|
| virtual void | setName (const DtString &) |
| | Set the name of the object.
|
| virtual const char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| | Routine to return a human readable form of the reader/writer variable.
|
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| | Runs a variable binding pass on this reader writer and any of its children.
|
virtual std::list
< DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| | Returns true if this variable has a child p in it's chain.
|
| virtual bool | hasVariableReference () const |
| | Returns true if this item or any item in the registry (recursive) is a variable reference.
|
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| | Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
|
| virtual void | recordUpdateTime () const |
| | Can be implemented in subclasses to stamp the time when updated.
|
| virtual bool | wasUpdatedSince (DtTime t) const |
| | Can be implemented in subclasses to return true if an update occurred after the specified time.
|
| virtual bool | changedSinceLastChecked () |
| | Returns true if this objects value has changed since the last time this function was called.
|
| virtual bool | peekChangedSinceLastChecked () const |
| | Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
|
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| | The specified flags are used for optional values.
|
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| | Specifies whether or not this reader writer is really a variable that is specified elsewhere.
|
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| | Clears out all variable reference flags from all readerwriter items in registry recursively.
|
| virtual DtSymbolString | variableName () const |
| | The variable name, if this object is a variable reference.
|
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| | The default value to use if the reader/writer object is a variable and that variable is not specified.
|
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| | Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
|
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| | Give the stream, if the stream contains a default value then set it here.
|
| const DtReaderWriterRegistry & | registry () const |
| | Collection of child DtReaderWriter nodes owned by this object.
|
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| | Writes contents of xml result to the given filename.
|
| virtual bool | fromXml (const DtString &) |
| | Restores object from given xml string. Returns true if valid.
|
| virtual bool | fromXmlFile (const DtFilename &) |
| | Restores object from given xml file.
|
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| | Override to add attributes of actual data.
|
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| | Called when the item is a variable reference.
|
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| | Gets data from the environment value.
|
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| | Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
|
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| | Called when the item is a variable reference.
|
Public Member Functions inherited from DtSingleTaskControllerComponent