![]() |
VR-Forces 4.1 Class Documentation
|
This controller is part of the traffic spawn system. More...

Public Member Functions | |
| DtSpawnController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| Constructors, etc. | |
| virtual | ~DtSpawnController () |
| destructor | |
| virtual DtString | type () const |
| This returns a string from compTypes.h, and identifies the type of component. | |
| virtual void | registerTaskMsgCallbacks () |
| Register a callback for notification of DtUserTask messages. | |
| virtual void | unregisterTaskMsgCallbacks () |
| Unregister a callback for notification of DtUserTask messages. | |
| virtual bool | init () |
| Calls setRadio() | |
| virtual void | preFirstTickInit () |
| Tick. | |
| virtual void | tick () |
| Tick the publisher if the component is on. | |
| const DtRwSpawnData & | spawnParameters () const |
| Provide the parameter data that the controller is using. | |
| void | setSpawnParameters (const DtRwSpawnData ¶ms) |
| Mutator that allows another module to set this controller's parameters–thus making it independent of a template. | |
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. | |
| virtual void | taskNotify (const DtSimTask &task) |
| This is used by the entity to notify all controllers that a new task has been received. | |
| virtual void | clearTask () |
| Called when you want to clear out this component's task state. | |
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 bool | postAddComponentsInit () |
| Called after all components have been created, initialized and added to the component manager. | |
| virtual void | postTick () |
| This function is called immediately after tick() is called. | |
| 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 void | enable () |
| Is this component enabled or not. | |
| virtual void | disable () |
| Is this component enabled or not. | |
| 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 | |
| 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 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 | settingConsumerCallback (const DtSettingsObject *settingsObject, void *usr) |
| Initialization functions. | |
Protected Member Functions | |
| virtual void | processSetting (const DtBoolSetting *setting) |
| virtual DtSpawnControllerPSR * | createPSR () |
| virtual void | processUpdateSpawnInstanceCallback (const DtVrfObjectMessage *msg) |
| virtual void | processSetTemplateNameCallback (const DtVrfObjectMessage *msg) |
| virtual void | processRequestSpawnPtDataCallback (const DtVrfObjectMessage *msg) |
| virtual void | processObjectRemoved (DtVrfObject *object) |
| virtual void | processObjectRenamed (const DtVrfObjectNameChangedCallbackInfo &info) |
| virtual void | embarkIfSpawnAttached (DtVrfObject *) |
| If the spawn point is attached embark the supplied object at the spawn point location via the set embarked message with the body offset being the offset of the spawn point from the center of mass of what it is attached to. | |
| virtual std::list< DtVrfObject * > | testAndSinkTraffic () |
| Private utility functions used during the tick. | |
| virtual bool | shouldSinkObject (DtVrfObject *trafficObject, DtVrfObject *sinkPoint) |
| virtual void | deleteObjects (const std::list< DtVrfObject * > &objectList) |
| Deletes the VRF objects contained in this list. | |
| virtual bool | canCreateNow (DtTime timeNow) const |
| Determine if the time parameters permit creation now. | |
| virtual DtString | findSinkPoint () |
| Select a sink point randomly from the list in the template. | |
| virtual DtTime | nextCreationTime (DtTime timeNow) |
| Determine the next entity creation time. | |
| virtual DtVrfObject * | createObject (DtVrfObject *sinkPoint, DtVrfObject *objectToRecycle=0) |
| Create a new traffic object, or recycle an old one into a new one. | |
| virtual DtVector | creationLocationAndOrientation (double &heading, DtVrfObject *sinkPoint) |
| Finds the creation location and orientation for a new traffic entity. | |
| virtual void | createAndSendDefaultPlan (DtVrfObject *obj, const DtString &sinkName) |
| Gives the spawned entity the default plan (move to sink point and delete self) and sends it to the entity. | |
| virtual double | trafficSpeed () |
| Calculates and returns the speed for a new traffic entity. | |
| virtual void | sendEntityPlan (DtVrfObject *entity, const DtPlan &plan) |
| Puts the entityPlan in a message and sends it to the spawned entity. | |
| virtual bool | trafficObjectType (DtRwObjectTypeInfo &objType) |
| Provides object type to be used to generate a new traffic entity. | |
| void | findClosestRoadSpawnPoints () |
| Find closest points on road network for spawning on roads. | |
Protected Member Functions inherited from DtControllerComponent | |
| DtControllerComponent () | |
| default constructor | |
| DtControllerComponent (const DtControllerComponent &orig) | |
| copy constructor | |
| const DtControllerComponent & | operator= (const DtControllerComponent &orig) |
| assignment operator | |
| virtual void | setRadio (DtSimBaseRadio *radio) |
Protected Member Functions inherited from DtSimComponent | |
| bool | testInvariant () const |
| virtual bool | createPortGroups () |
| Called by init. | |
| virtual bool | createPorts () |
| Called by init. | |
| 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 |
Protected Member Functions inherited from DtReaderWriter | |
| 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. | |
Static Protected Member Functions | |
| static void | updateSpawnInstanceCallback (const DtVrfObjectMessage *msg, void *usr) |
| Callback functions for messages. | |
| static void | setTemplateNameCallback (const DtVrfObjectMessage *msg, void *usr) |
| static void | requestSpawnPtDataCallback (const DtVrfObjectMessage *msg, void *usr) |
| static void | objectRemovedCallback (DtVrfObject *object, void *usr) |
| static void | objectRenamedCallback (const DtVrfObjectNameChangedCallbackInfo &info, void *usr) |
Private Member Functions | |
| DtSpawnController () | |
| Default constructor; not implemented. | |
| DtSpawnController (const DtSpawnController &orig) | |
| copy constructor; not implemented. | |
| const DtSpawnController & | operator= (const DtSpawnController &orig) |
| assignment operator; not implemented. | |
Additional Inherited Members | |
Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
Protected Types inherited from 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 Attributes inherited from DtSimComponent | |
| static DtSimComponentFactory * | myFactory |
This controller is part of the traffic spawn system.
It creates new entities at a defined interval and gives them a plan to move toward a random sink object. It then monitors these entities, when when they are close to their sink point, it deletes them.
| BHAVE::DtSpawnController::DtSpawnController | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
Constructors, etc.
|
virtual |
destructor
|
private |
Default constructor; not implemented.
|
private |
copy constructor; not implemented.
|
virtual |
This returns a string from compTypes.h, and identifies the type of component.
Reimplemented from DtControllerComponent.
|
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). |
|
static |
Initialization functions.
|
virtual |
Register a callback for notification of DtUserTask messages.
Overrides this so it can register its interest in DtUserTask* commands
|
virtual |
Unregister a callback for notification of DtUserTask messages.
This is used if the entity cannot process DtUserTasks
|
virtual |
Calls setRadio()
Reimplemented from DtControllerComponent.
|
protectedvirtual |
|
protectedvirtual |
|
staticprotected |
Callback functions for messages.
|
protectedvirtual |
|
staticprotected |
|
protectedvirtual |
|
staticprotected |
|
protectedvirtual |
|
staticprotected |
|
protectedvirtual |
|
staticprotected |
|
protectedvirtual |
|
protectedvirtual |
If the spawn point is attached embark the supplied object at the spawn point location via the set embarked message with the body offset being the offset of the spawn point from the center of mass of what it is attached to.
|
virtual |
Tick.
The controller must get the pointer to its template at this point; it can't do that in a postScenarioLoad callback function because the spawn-sink manager may not have loaded its templates yet. Also, the init() function is called before postScenarioLoad. See also spawnControllerPSR.h, setTemplateName().
Reimplemented from DtSimComponent.
|
virtual |
Tick the publisher if the component is on.
Reimplemented from DtSimComponent.
| const DtRwSpawnData& BHAVE::DtSpawnController::spawnParameters | ( | ) | const |
Provide the parameter data that the controller is using.
| void BHAVE::DtSpawnController::setSpawnParameters | ( | const DtRwSpawnData & | params | ) |
Mutator that allows another module to set this controller's parameters–thus making it independent of a template.
|
protectedvirtual |
Private utility functions used during the tick.
Check if any of the traffic objects are near their sink points, and delete them if needed.
|
protectedvirtual |
|
protectedvirtual |
Deletes the VRF objects contained in this list.
|
protectedvirtual |
Determine if the time parameters permit creation now.
The standard version checks is-time-based, then compares time with start and end times; also checks is-cyclic, and then cycle-period, duty-cycle, and start-offset to determine if the current time is in an active window. The function also checks to see if the current time is past the PSR->nextCycleStartTime(); if so, it computes the start time of the next burst cycle and updates lastCycleStartTime and nextCycleStartTime. All checks assume that the parameters, and the function argument, are in sim time unless isTimeBased and usesClockTime are true.
|
protectedvirtual |
Select a sink point randomly from the list in the template.
|
protectedvirtual |
Determine the next entity creation time.
The standard version of this method takes the current time, adds period +- variance% x period.
|
protectedvirtual |
Create a new traffic object, or recycle an old one into a new one.
|
protectedvirtual |
Finds the creation location and orientation for a new traffic entity.
|
protectedvirtual |
Gives the spawned entity the default plan (move to sink point and delete self) and sends it to the entity.
|
protectedvirtual |
Calculates and returns the speed for a new traffic entity.
This will be a random number between min speed and max speed.
|
protectedvirtual |
Puts the entityPlan in a message and sends it to the spawned entity.
|
protectedvirtual |
Provides object type to be used to generate a new traffic entity.
Will be a random object type from the traffic object type list.
|
protected |
Find closest points on road network for spawning on roads.
|
private |
assignment operator; not implemented.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |