![]() |
VR-Forces 4.6 Class Documentation
|
DtObjectSensor is a base level sensor component. More...

Public Member Functions | |
| DtObjectSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtObjectSensor () |
| destructor | |
| virtual bool | init () |
| Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry(). | |
| virtual bool | postAddComponentsInit () |
| Called after all components have been created, initialized and added to the component manager. | |
| virtual void | preFirstTickInit () |
| Initializes the component before it is ticked for the first time. | |
| virtual const char * | type () const |
| Returns a string identifies the class type of component. | |
| virtual void | tick () |
| Processes only if the simulation is not paused. | |
| virtual bool | tickWhileDestroyed () const |
| virtual int | sensorType () const |
| virtual void | setSensorEnabled (bool enabled) |
| virtual bool | sensorEnabled () const |
| Whether this sensor is enabled or disabled. | |
| virtual void | disable () |
| Overridden to clear out the target list and update the monitor so that the sensor contact list will be cleared out in the front-end when the sensor is disabled. | |
| virtual void | setIsEnabled (bool yesNo) |
| virtual void | setTypesToDetectForTask (const DtRwObjectTypeList &objectTypes) |
| Set or clear the dynamic list of object types to detect. | |
| virtual void | clearTypesToDetectForTask () |
| Clear all types. Should be called when the task is done. | |
| virtual const DtRwObjectTypeList & | typesToDetectForTask () const |
| Gets the type list. | |
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 | 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 (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 | taskVisualizationsActive () const |
| Returns true if task visualizations are currently active for this component. | |
| virtual bool | taskVisualizationsEnabled () const |
| Returns true if task visualizations are enabled for this component. | |
| virtual void | enable () |
| Is this component enabled or not. | |
| virtual bool | isEnabled () |
| 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 |
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) | |
| 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. | |
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 Public Member Functions inherited from DtSimComponent | |
| static DtSimComponent * | MarkThreadSafe (DtSimComponent *) |
| static DtSimComponentFactory * | factory () |
| A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. | |
| static void | setFactory (DtSimComponentFactory *factory) |
| static DtSimComponent * | createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a DtSimComponent using the factory, then initializes it via the MTL stream. | |
| static void | addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn) |
| Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. | |
Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (std::string &fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static void | setPutIndent (bool) |
| static bool | putIndent () |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| static DtObjectCounter::CounterType | ObjectCount () |
| static const DtObjectContainer * | ObjectContainer () |
Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent > | |
| static DtObjectCounter::CounterType | ObjectCount () |
| static const DtObjectContainer * | ObjectContainer () |
Protected Member Functions | |
| virtual bool | createPortGroups () |
| Creates and initializes port groups. | |
| virtual bool | createPorts () |
| Creates the target list port. | |
| virtual DtObjectSensorPSR * | createPSR () |
| Creates myProcessState data member, and adds it to our process state repository manager. | |
| virtual const char * | defaultPSRType () const |
| virtual void | initSensorRangeRing () |
| Adds a sensor range ring to the range rings published for this object with the system-name.sensor-name as the title. | |
| virtual void | updateDetectableObjectsList () |
| Sets up myDetectableObjectList as a list that contains all entity types/forces specified in both the descriptor and the myObjectsToDetectInputPort input port. | |
| virtual bool | initSensorGeometry () |
| Creates the geometry evaluator based on the sensor-geometry entry in the descriptor, and the sensor geometry evaluator factory. | |
| virtual void | setupGeometryForDetection () |
| Sets up the current sensor geometry evaluator with the current position and orientation of the sensor. | |
| virtual DtVector | localSensorPosition () const |
| virtual DtVector | bodySensorPosition () const |
| virtual DtTaitBryan | localSensorOrientation () const |
| virtual DtTaitBryan | bodySensorOrientation () const |
| virtual DtUUID | targetObject () const |
| virtual DtVector | targetLocation () const |
| virtual DtSensorTrackingMode | trackingMode () const |
| virtual bool | processObjects () |
| Checks detectability of each of the detectable objects. | |
| virtual bool | detectObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo) |
| virtual bool | continueDetectingObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified) |
| virtual bool | objectWithinSensorGeometry (DtVrfObject *object) const |
| virtual double | rangeSquaredToObject (const DtVrfObject *object) const |
| virtual double | rangeToObject (const DtVrfObject *object) const |
| virtual void | clearObjectRangeCache () const |
| Invalidates the current object range cache. | |
| virtual void | printTargets () const |
| Prints the current target list to the console. | |
| virtual void | updateDetectedObjectListPort () |
| Clears the list port, then adds all target infos from the previous target list in the PSR, and sends the data. | |
| virtual bool | createAndInitSensorMonitor () |
| Creates a DtObjectSensorMonitor, and calls init() on it. | |
| virtual bool | objectInDetectableList (DtVrfObject *) const |
| Returns true if the object is in the myDetectableObjectList. | |
| virtual void | processHostilitiesChanged (DtU8 force) |
| virtual DtTaitBryan | worldOrientationOfObject (DtVrfObject *object) const |
| Given the object, if this is a single point object return the orientation in the vrfState() else return orientation as calculated for multi-point objects (closed figure is origin to first point, non-closed is origin to last point). | |
| virtual bool | canDetectForceOfObject (DtVrfObject *) |
| Return false if the force of the object supplied cannot be detected by this force. | |
| virtual void | processSetSensorEnabledRequestMessage (DtSimMessage *msg) |
| Calls setSensorEnabled() with the value specified in the message if the message matches our sensor name. | |
| DtCompositePredicate | objectTypeForcePredicate (const DtObjectType &, const DtNLengthIntegerVector &forceTypes) |
| Specifies force types as s DtNLenghtIntegerVector. | |
| DtCompositePredicate | objectTypeForcePredicate (const DtObjectType &, const std::list< DtU8 > &forceTypes) |
| Specifies force types as a std::list. | |
Protected Member Functions inherited from DtSimComponent | |
| virtual double | computeCurrentTime () |
| Compute current time and myDT. | |
| bool | testInvariant () const |
| DtVrfProcessStateRepository * | createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true) |
| Creates a PSR for this component and registers it with the PSR manager. | |
| virtual void | updateTaskVisualizations () |
| Called to update task visualizations after every tick. | |
| virtual void | destroyTaskVisualizations () |
| Destroys all task visualizations for this component. | |
| virtual void | destroyTaskVisualization (const DtString &name) |
| Destroys an existing task visualization. | |
| virtual DtPointTaskVisualizationPtr | pointTaskVisualization (const DtString &name) |
| Finds an existing or creates a new point task visualization with the given name. | |
| virtual DtLineTaskVisualizationPtr | lineTaskVisualization (const DtString &name) |
| Finds an existing or creates a new line task visualization with the given name. | |
| virtual DtAreaTaskVisualizationPtr | areaTaskVisualization (const DtString &name) |
| Finds an existing or creates a new area task visualization with the given name. | |
| virtual DtTextTaskVisualizationPtr | textTaskVisualization (const DtString &name) |
| Finds an existing or creates a new text task visualization with the given name. | |
| double | calculateNextTaskVisTickTime () const |
| Determines the next time the task visualizations should be ticked. | |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
Static Protected Member Functions | |
| static void | hostilitiesChangedCallback (DtU8 force, void *usr) |
| If who were hostile towards has changed we will need to update our myDetectableObjectList. | |
| static void | setSensorEnabledRequestCallback (DtSimMessage *msg, void *usrData) |
| Static callback method for setSensorEnabled messages. | |
Protected Attributes | |
| DtManagedObjectListConstPtr | myDetectableObjectList |
| const DtObjectSensorDescriptor * | myObjectSensorDescriptor |
| DtObjectSensorPSR * | myProcessState |
| Container for state data associated with this component. | |
| DtObjectSensorMonitor * | myMonitor |
| Sends out sensor contact information to the GUI if the GUI or other application has requested the information. | |
| DtSpatialFilterEvaluator * | mySensorGeometryEvaluator |
| DtForceType | myForceType |
| The force type the last time the detectable object list was updated. | |
| const DtVrfObject * | myMutableObjectCached |
| The VrfObject whose range is currently cached. | |
| bool | myMutableObjectRangeCalculated |
| Keeps track of whether the range has been calculated for the current cached object. | |
| double | myMutableObjectRangeCache |
| The current range to the cached object, if calculated. | |
| bool | myMutableObjectRangeSquaredCalculated |
| Keeps track of whether the range squared has been calculated for the current cached object. | |
| double | myMutableObjectRangeSquaredCache |
| The current range squared to the cached object, if calculated. | |
| bool | myGeometrySetup |
| Whether setupGeometryForDetection() has been called yet. | |
| bool | myPrep_detectedObjectsChangesMade |
| bool | myPrep_invokeNewContactCallbacks |
Ports and Port Groups | |
| DtSensorContactListOutputPort * | myDetectedObjectListPort |
| Outputs: Output Port Name: detected-objects Output Port Description: The list of contacts detected by this sensor. | |
| DtObjectTypesListMultiInputPort * | myObjectsToDetectInputPort |
| Inputs: DtObjectTypesListMultiInputPort : object-types-to-detect Input Port Name: object-types-to-detect Input Port Description: List of contacts to be considered for target selection. | |
| DtInputPortGroup * | mySensorOffsetInputPortGroup |
| Input Port Group Name: sensor-offset Input Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity's position. | |
| DtOrientationInputPort * | myOrientationInputPort |
| Input Port Name: orientation Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted. | |
| DtVectorInputPort * | myPositionInputPort |
| Input Port Name: position Input Port Description: Specifies the position of the sensor in body coordinates relative to the entity which it is mounted on. | |
| DtStringInputPort * | myTargetObjectInputPort |
| Input Port Name: target-object Input Port Description: Specifies the name of the object be targeted by this sensor. | |
| DtVectorInputPort * | myTargetLocationInputPort |
| Input Port Name: target-location Input Port Description: Specifies the location to be targeted by this sensor. | |
| DtIntegerInputPort * | myTrackingModeInputPort |
| Input Port Name: tracking-mode Input Port Description: Specifies the tracking mode of the sensor. | |
| DtBooleanInputPort * | myTargetAcquiredInputPort |
| Input Port Name: target-acquired Input Port Description: Specifies whether the sensor was able to acquire the target. | |
Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| Pointer to the DtComponentSystem that this component belongs. | |
| DtListItem * | myListItem |
| DtInputPortMap | myInputPortList |
| DtOutputPortMap | myOutputPortList |
| DtInputPortGroupMap | myInputPortGroupList |
| DtOutputPortGroupMap | myOutputPortGroupList |
| int | myPriority |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| double | myLastTickSimTime |
| double | myDT |
| bool | myIsEnabled |
| Indicates whether this component should be enabled for ticking or not. | |
| bool | myFirstTick |
| Initialized to true in the constructor, set to false by the first call to postTick. | |
| bool | myIsThreadSafe |
| Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. | |
| const DtComponentDescriptor * | myComponentDescriptor |
| std::list < DtVrfProcessStateRepository * > | myComponentPsrs |
| List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. | |
| bool | myTickEveryFrame |
| Flag indicating that tickPeriod is set to 0, and the component will tick every frame. | |
| DtTaskVisualizationMap | myTaskVisualizations |
| The visualization objects to be drawn for this component. | |
| double | myNextTaskVisTickTime |
| The next tick time for updating the task visualizations. | |
Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. | |
Private Member Functions | |
| DtObjectSensor () | |
| default constructor; not implemented | |
| DtObjectSensor (const DtObjectSensor &orig) | |
| copy constructor; not implemented | |
| const DtObjectSensor & | operator= (const DtObjectSensor &orig) |
| assignment operator; not implemented | |
| virtual bool | setTypesToDetectAttribute (DtReaderWriter *val) |
| static bool | setTypesToDetectAttribute (void *ctrlr, DtReaderWriter *val) |
| Attribute set functions to accept types to detect or clear the list of task-specific types. | |
| virtual bool | clearTypesToDetect (DtReaderWriter *val) |
| static bool | clearTypesToDetect (void *ctrlr, DtReaderWriter *val) |
| This function ignores the value passed in. | |
Additional Inherited Members | |
Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
Protected Types inherited from 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 |
DtObjectSensor is a base level sensor component.
End User Description: Manages a filtered list of detectable targets, as specified in the descriptor, and sets up infrastructure for specific sensor types to run their algorithms on the list. Manages sending of sensor data to the GUI though messages. Manages sensor geometry. Configuring a DtObjectSensor on an entity will cause it to detect all entities of types specified in the descriptor within the geometric region specified by the sensor geometry. No tests for terrain obstruction or sensor signatures will be done. For this functionality, use a DtSignatureObjectSensor.
Uses Descriptor Type: DtObjectSensorDescriptor.
|
private |
default constructor; not implemented
|
private |
copy constructor; not implemented
| DtObjectSensor::DtObjectSensor | ( | 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
|
private |
assignment operator; not implemented
|
virtual |
Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry().
This must be called after construction and before the sensor is used on an entity.
Reimplemented from DtSimComponent.
Reimplemented in DtRadarObjectSensor, DtSignatureObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
virtual |
Called after all components have been created, initialized and added to the component manager.
Ensures output ports have been activated and pre-populated before any other components looks for the data on their input ports.
Reimplemented from DtSimComponent.
|
virtual |
Initializes the component before it is ticked for the first time.
It is called by timedTick if myFirstTick is true.
Reimplemented from DtSimComponent.
Reimplemented in DtRadarObjectSensor, and DtSignatureObjectSensor.
|
virtual |
Returns a string identifies the class type of component.
Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.
Implements DtSimComponent.
Reimplemented in DtSignatureObjectSensor, DtRadarObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
virtual |
Processes only if the simulation is not paused.
Calls attemptToActivate() on myDetectedObjectListPort. Calls clearObjectRangeCache(). Calls setupGeometryForDetection() Calls processObjects(). When processObjects() returns true, calls notifyTargetsChanged() on the DtObjectSensorModitor. Calls updateDetectedObjectListPort().
Reimplemented from DtSimComponent.
Reimplemented in DtSignatureObjectSensor, DtRadarObjectSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
virtual |
Reimplemented from DtSimComponent.
|
virtual |
Reimplemented in DtSignatureObjectSensor, DtRadarObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
virtual |
Overridden to clear out the target list and update the monitor so that the sensor contact list will be cleared out in the front-end when the sensor is disabled.
Reimplemented from DtSimComponent.
|
virtual |
Reimplemented from DtSimComponent.
|
virtual |
Set or clear the dynamic list of object types to detect.
This is useful for a task that wants to look for a type of object; the task should clear this when it is done.
Set types. The types are saved in the PSR. Calls updateDetectbaleObjectsList.
|
virtual |
Clear all types. Should be called when the task is done.
|
virtual |
Gets the type list.
|
static |
Attribute set functions to accept types to detect or clear the list of task-specific types.
The static functions are registered as callbacks, and the virtual functions perform the set.
This function accepts a value that is a single string representing a list of types. Each type is a colon-separated set of 8 integers (object types), and types are separated by commas.
|
virtual |
|
static |
This function ignores the value passed in.
It clears the list of types.
|
virtual |
|
virtual |
Enables or disables this sensor.
Reimplemented in DtSignatureObjectSensor, DtRadarObjectSensor, and DtActiveSonarSensor.
|
virtual |
Whether this sensor is enabled or disabled.
|
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 in DtSignatureObjectSensor, DtRadarObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
protectedvirtual |
Creates and initializes port groups.
Reimplemented from DtSimComponent.
|
protectedvirtual |
Creates the target list port.
Reimplemented from DtSimComponent.
Reimplemented in DtSignatureObjectSensor.
|
protectedvirtual |
Creates myProcessState data member, and adds it to our process state repository manager.
Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.
|
protectedvirtual |
Reimplemented in DtRadarObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, and DtSignatureObjectSensor.
|
protectedvirtual |
Adds a sensor range ring to the range rings published for this object with the system-name.sensor-name as the title.
If there is no range evaluator for this sensor in the sensor geometry (max range) then a ring for this sensor will not be added
|
protectedvirtual |
Sets up myDetectableObjectList as a list that contains all entity types/forces specified in both the descriptor and the myObjectsToDetectInputPort input port.
DtTargetSelectionController and DtSpotReportGeneratorController are examples of controllers that provide lists of types of objects to detect. Uses objectTypeForcePredicate() to create the predicate for each type/force specified.
|
protected |
Specifies force types as s DtNLenghtIntegerVector.
|
protected |
Specifies force types as a std::list.
|
protectedvirtual |
Creates the geometry evaluator based on the sensor-geometry entry in the descriptor, and the sensor geometry evaluator factory.
|
protectedvirtual |
Sets up the current sensor geometry evaluator with the current position and orientation of the sensor.
Called once per detection cycle.
Reimplemented in DtSignatureObjectSensor.
|
protectedvirtual |
Reimplemented in DtSignatureObjectSensor.
|
protectedvirtual |
Reimplemented in DtSignatureObjectSensor.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Checks detectability of each of the detectable objects.
This is done by calling continueDetectingObject() for all objects previously detected. For any that return false, they are removed from the list. For all objects that weren't previously detected, detectObject() is called. For any where the return value is true, they are added to the detected objects list in the PSR.
Reimplemented in DtRadarObjectSensor.
|
protectedvirtual |
Reimplemented in DtRadarObjectSensor, DtSignatureObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
protectedvirtual |
Reimplemented in DtRadarObjectSensor, DtSignatureObjectSensor, DtPassiveSonarSensor, DtActiveSonarSensor, DtNbcSensor, and DtEngineeringObjectSensor.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Invalidates the current object range cache.
|
protectedvirtual |
Prints the current target list to the console.
|
protectedvirtual |
Clears the list port, then adds all target infos from the previous target list in the PSR, and sends the data.
|
protectedvirtual |
Creates a DtObjectSensorMonitor, and calls init() on it.
|
protectedvirtual |
Returns true if the object is in the myDetectableObjectList.
|
staticprotected |
If who were hostile towards has changed we will need to update our myDetectableObjectList.
|
protectedvirtual |
|
protectedvirtual |
Given the object, if this is a single point object return the orientation in the vrfState() else return orientation as calculated for multi-point objects (closed figure is origin to first point, non-closed is origin to last point).
The resultant orientation is a geocentric orientation
|
protectedvirtual |
Return false if the force of the object supplied cannot be detected by this force.
Currently will only return false if an intelligence object that cannot be detected by this force
|
staticprotected |
Static callback method for setSensorEnabled messages.
|
protectedvirtual |
Calls setSensorEnabled() with the value specified in the message if the message matches our sensor name.
|
protected |
Outputs: Output Port Name: detected-objects
Output Port Description: The list of contacts detected by this sensor.
Output Port Range:
Output Port Default Value:
Output Group Parent:
|
protected |
Inputs: DtObjectTypesListMultiInputPort : object-types-to-detect Input Port Name: object-types-to-detect
Input Port Description: List of contacts to be considered for target selection.
As many contact lists as desired can be connected and work simultaneously.
Input Port Range:
Input Port Default Value:
Input Group Parent: object-types-to-detect
|
protected |
Input Port Group Name: sensor-offset
Input Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity's position.
|
protected |
Input Port Name: orientation
Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted.
Input Port Range:
Input Port Default Value: 0,0,0
Input Group Parent: sensor-offset
|
protected |
Input Port Name: position
Input Port Description: Specifies the position of the sensor in body coordinates relative to the entity which it is mounted on.
If this port is not connected localSensorPosition() simply returns the local position of the entity.
Input Port Range:
Input Port Default Value: 0,0,0
Input Group Parent: sensor-offset
|
protected |
Input Port Name: target-object
Input Port Description: Specifies the name of the object be targeted by this sensor.
Can give context to sensor orientation.
Input Port Range:
Input Port Default Value: ""
Input Group Parent:
|
protected |
Input Port Name: target-location
Input Port Description: Specifies the location to be targeted by this sensor.
Can give context to sensor orientation.
Input Port Range:
Input Port Default Value: ""
Input Group Parent:
|
protected |
Input Port Name: tracking-mode
Input Port Description: Specifies the tracking mode of the sensor.
Input Port Range: Values specified by DtSensorTrackingMode enum
Input Port Default Value: ""
Input Group Parent:
|
protected |
Input Port Name: target-acquired
Input Port Description: Specifies whether the sensor was able to acquire the target.
Input Port Range:
Input Port Default Value: ""
Input Group Parent:
|
protected |
|
protected |
|
protected |
Container for state data associated with this component.
This state is saved and restored as part of a scenario (or checkpoint).
|
protected |
Sends out sensor contact information to the GUI if the GUI or other application has requested the information.
|
protected |
|
protected |
The force type the last time the detectable object list was updated.
|
mutableprotected |
The VrfObject whose range is currently cached.
|
mutableprotected |
Keeps track of whether the range has been calculated for the current cached object.
|
mutableprotected |
The current range to the cached object, if calculated.
|
mutableprotected |
Keeps track of whether the range squared has been calculated for the current cached object.
|
mutableprotected |
The current range squared to the cached object, if calculated.
|
protected |
Whether setupGeometryForDetection() has been called yet.
|
protected |
|
protected |