VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtEngineeringObjectSensor Class Reference
Inheritance diagram for DtEngineeringObjectSensor:
Inheritance graph
[legend]

Public Member Functions

 DtEngineeringObjectSensor (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtEngineeringObjectSensor () override
 
virtual bool init () override
 
virtual const chartype () const override
 
virtual int sensorType () const override
 
virtual void tick () override
 
- Public Member Functions inherited from DtObjectSensor
 DtObjectSensor (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtObjectSensor () override
 
virtual bool postAddComponentsInit () override
 
virtual void preFirstTickInit () override
 
virtual bool tickWhileDestroyed () const override
 
virtual void enable () override
 
virtual void disable () override
 
virtual void setIsEnabled (bool yesNo) override
 
virtual void setTypesToDetectForTask (const DtRwEntityTypeList &objectTypes)
 
virtual void clearTypesToDetectForTask ()
 
virtual const DtRwEntityTypeListtypesToDetectForTask () const
 
virtual bool setTypesToDetectAttribute (DtReaderWriter *val)
 
virtual bool clearTypesToDetect (DtReaderWriter *val)
 
virtual DtReaderWritergetSensorPositionAttribute ()
 
virtual void setSensorEnabled (bool enabled)
 
virtual bool sensorEnabled () const
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent () override
 
virtual void setParentSystem (DtComponentSystem *system)
 
DtComponentSystemparentSystem () const
 
virtual void registerAttributeFunctions ()
 
virtual void postTick ()
 
virtual void timedTick ()
 
virtual void setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
 
virtual void setupFirstTickTime ()
 
virtual void setEntity (DtLocalObject *entity)
 
virtual DtSimComponentnextComponent ()
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 
virtual DtListItem * listItem ()
 
virtual void putData (std::string &fp, int indentLevel=0) override
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void addInputPort (DtInputPort *port)
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 
virtual DtList inputPortList () const
 
virtual void addOutputPort (DtOutputPort *port)
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 
virtual DtList outputPortList () const
 
virtual void addInputPortGroup (DtInputPortGroup *group)
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 
virtual DtList inputPortGroupList () const
 
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 
virtual DtList outputPortGroupList () const
 
virtual int priority () const
 
virtual void setPriority (int priority)
 
double dT () const
 
virtual void setDT (double deltaT)
 
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 
const DtPhysicalWorldphysicalWorld () const
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtLocalObjectentity ()
 
const DtLocalObjectentity () const
 
DtSimulationServicessimulationServices ()
 
const DtSimulationServicessimulationServices () const
 
const Coordinate_SystemcoordinateSystem () const
 
virtual void isClutterChanged ()
 
virtual bool taskVisualizationsActive () const
 
virtual bool taskVisualizationsEnabled () const
 
virtual void onRestore ()
 
makVrf::DtTaskVisualizationMaptaskVisualizations ()
 
virtual void updateImgui ()
 
virtual bool debugActive () const
 
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 int notifyLevel () const
 
virtual DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
VRF4API_METHOD const
DtSimulationServices
simManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs) const
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
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())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtObjectSensor
static bool setTypesToDetectAttribute (void *ctrlr, DtReaderWriter *val)
 
static bool clearTypesToDetect (void *ctrlr, DtReaderWriter *val)
 
static DtReaderWritergetSensorPositionAttribute (void *ctrlr)
 
static DtSimComponentcreator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
static void printDiagnosticsCallback (const DtVrfObjectMessage *msg, void *usr)
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactoryfactory ()
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 
static VRF4API_METHOD
DtSimComponent
MarkThreadSafe (DtSimComponent *comp)
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

virtual bool detectObject (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo) override
 
virtual ContinueDetectingResult continueDetectingObject (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified) override
 
virtual int detectionLevel (const DtSimObject *object, const DtRwSensorContactInfo *contactInfo)
 
virtual void updateEngineeringSensorContactInfo (const DtSimObject *object, DtRwSensorContactInfo *contactInfo, int level)
 
- Protected Member Functions inherited from DtObjectSensor
virtual bool createPortGroups () override
 
virtual bool createPorts () override
 
virtual DtObjectSensorPSRcreatePSR ()
 
virtual const chardefaultPSRType () const
 
virtual void initSensorRangeRing ()
 
virtual void updateDetectableObjectsList ()
 
virtual bool initSensorGeometry ()
 
virtual void setupGeometryForDetection ()
 
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 void processObjects ()
 
virtual void processObjectsSlice (const DtInterruptFlag &timer)
 
virtual bool objectWithinSensorGeometry (const DtSimObject *object) const
 
virtual bool sensorGeometryExtent (DtExtent &extent) const
 
virtual double rangeSquaredToObject (const DtSimObject *object) const
 
virtual double rangeToObject (const DtSimObject *object) const
 
virtual void clearObjectRangeCache () const
 
virtual void printTargets () const
 
virtual void updateDetectedObjectListPort ()
 
virtual bool createAndInitSensorMonitors ()
 
virtual bool objectInDetectableList (const DtSimObject *) const
 
virtual void processHostilitiesChanged (DtU8 force)
 
virtual DtTaitBryan worldOrientationOfObject (const DtSimObject *object) const
 
virtual bool canDetectForceOfObject (const DtSimObject *)
 
virtual void processSetSensorEnabledRequestMessage (DtSimMessage *msg)
 
virtual void notifyContactsChanged ()
 
virtual void printDiagnostics (const DtVrfObjectMessage *msg)
 
- Protected Member Functions inherited from DtSimComponent
virtual void setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
 
virtual double computeCurrentTime ()
 
bool testInvariant () const
 
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 
virtual void updateTaskVisualizations ()
 
virtual void destroyTaskVisualizations ()
 
virtual void destroyTaskVisualization (const DtString &name)
 
virtual
makVrf::DtPointTaskVisualizationPtr 
pointTaskVisualization (const DtString &name)
 
virtual
makVrf::DtLineTaskVisualizationPtr 
lineTaskVisualization (const DtString &name)
 
virtual
makVrf::DtAreaTaskVisualizationPtr 
areaTaskVisualization (const DtString &name)
 
virtual
makVrf::DtTextTaskVisualizationPtr 
textTaskVisualization (const DtString &name)
 
double calculateNextTaskVisTickTime () const
 
DtVrfObjectStateRepositorylocalStateRepository ()
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
DtPropertyInterfacecachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
 
template<typename ValType >
void setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
 
const DtPropertyInterfacecachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
 
template<typename ValType >
bool getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
 
void addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
 
void removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
 
void invokeSimObjectPredicateCallbacks ()
 
virtual void clearPredicateCallbacks ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtEngineeringObjectSensorDescriptormyDescriptor
 
boost::optional< doublemyFootprintProp
 
const DtRwPropertiesMapmyEnvAttritionProp
 
- Protected Attributes inherited from DtObjectSensor
DtManagedObjectListConstPtr myDetectableObjectList
 
const DtObjectSensorDescriptormyObjectSensorDescriptor
 
DtObjectSensorPSRmyProcessState
 
std::vector
< DtObjectSensorMonitor * > 
myMonitors
 
DtSpatialFilterEvaluatormySensorGeometryEvaluator
 
DtForceType myForceType
 
const DtSimObjectmyMutableObjectCached
 
bool myMutableObjectRangeCalculated
 
double myMutableObjectRangeCache
 
bool myMutableObjectRangeSquaredCalculated
 
double myMutableObjectRangeSquaredCache
 
bool myGeometrySetup
 
bool myPrep_invokeNewContactCallbacks
 
DtPlatformLocalObjectFacade myPlatformLocalObjectFacade
 
std::shared_ptr
< DtProcessObjectsState
myProcessObjectsState
 
DtSensorContactListOutputPortmyDetectedObjectListPort
 
DtEntityTypesListMultiInputPortmyObjectsToDetectInputPort
 
DtInputPortGroupmySensorOffsetInputPortGroup
 
DtOrientationInputPortmyOrientationInputPort
 
DtVectorInputPortmyPositionInputPort
 
DtStringInputPortmyTargetObjectInputPort
 
DtVectorInputPortmyTargetLocationInputPort
 
DtIntegerInputPortmyTrackingModeInputPort
 
DtBooleanInputPortmyTargetAcquiredInputPort
 
- Protected Attributes inherited from DtSimComponent
DtLocalObjectmyEntity
 
DtComponentSystemmySystem
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myLastTickSimTime
 
std::unique_ptr< DtTimedTickLogicmyTimedTickLogic
 
double myDT
 
bool myIsEnabled
 
bool myFirstTick
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 
makVrf::DtTaskVisualizationMap myTaskVisualizations
 
double myNextTaskVisTickTime
 
DtSymbolString myFullComponentName
 
DtSimulationServicesmySimServices
 
DtPredicateCallbackManagermyPredicateCallbackManager
 
boost::signals2::scoped_connection myIsClutterChangedConnection
 
bool myLocalDebug
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Private Member Functions

 DtEngineeringObjectSensor ()
 
 DtEngineeringObjectSensor (const DtEngineeringObjectSensor &orig)
 
const DtEngineeringObjectSensoroperator= (const DtEngineeringObjectSensor &orig)
 

Additional Inherited Members

- Public Types inherited from DtObjectSensor
enum  ContinueDetectingResult { DetectionLost = 0, DetectionContinued = 1, DetectionMissed = 2 }
 
- 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 Member Functions inherited from DtObjectSensor
static void hostilitiesChangedCallback (DtU8 force, void *usr)
 
static void setSensorEnabledRequestCallback (DtSimMessage *msg, void *usrData)
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtEngineeringObjectSensor::DtEngineeringObjectSensor ( )
private

default constructor; not implemented

DtEngineeringObjectSensor::DtEngineeringObjectSensor ( const DtEngineeringObjectSensor orig)
private

copy constructor; not implemented

DtEngineeringObjectSensor::DtEngineeringObjectSensor ( const DtString name,
DtLocalObject owner,
DtSimulationServices simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

Parameters
nameReader writer name of this component.
ownerThe DtLocalObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
virtual DtEngineeringObjectSensor::~DtEngineeringObjectSensor ( )
overridevirtual

destructor

Member Function Documentation

const DtEngineeringObjectSensor& DtEngineeringObjectSensor::operator= ( const DtEngineeringObjectSensor orig)
private

assignment operator; not implemented

virtual bool DtEngineeringObjectSensor::init ( )
overridevirtual

Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry(). This must be called after construction and before the sensor is used on an entity.

Reimplemented from DtObjectSensor.

virtual const char* DtEngineeringObjectSensor::type ( ) const
overridevirtual

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.

Returns
DtEngineeringObjectSensorType

Reimplemented from DtObjectSensor.

virtual int DtEngineeringObjectSensor::sensorType ( ) const
overridevirtual

Returns DtSensorTypeUnknown.

Reimplemented from DtObjectSensor.

virtual void DtEngineeringObjectSensor::tick ( )
overridevirtual

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 DtObjectSensor.

static DtSimComponent* DtEngineeringObjectSensor::creator ( const DtString name,
DtLocalObject owner,
DtSimulationServices simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

Parameters
nameReader writer name of this component.
ownerThe DtLocalObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
Returns
New instance of this class.
virtual bool DtEngineeringObjectSensor::detectObject ( DtSimObjectReference  object,
DtRwSensorContactInfo contactInfo 
)
overrideprotectedvirtual

Returns true if the object is an engineering object within the detection capabilities and range of this sensor.

Reimplemented from DtObjectSensor.

virtual ContinueDetectingResult DtEngineeringObjectSensor::continueDetectingObject ( DtSimObjectReference  object,
DtRwSensorContactInfo contactInfo,
bool contactInfoModified 
)
overrideprotectedvirtual

Returns true if the object is an engineering object within the detection capabilities and range of this sensor.

Reimplemented from DtObjectSensor.

virtual int DtEngineeringObjectSensor::detectionLevel ( const DtSimObject object,
const DtRwSensorContactInfo contactInfo 
)
protectedvirtual

Returns the detection level of the engineering object.

virtual void DtEngineeringObjectSensor::updateEngineeringSensorContactInfo ( const DtSimObject object,
DtRwSensorContactInfo contactInfo,
int  level 
)
protectedvirtual

Updates the contact info based on the detection of an engineering object.

Member Data Documentation

DtEngineeringObjectSensorDescriptor* DtEngineeringObjectSensor::myDescriptor
protected
boost::optional<double> DtEngineeringObjectSensor::myFootprintProp
protected

These properties gets cached in the tick function so it doesn't need to be looked up every time detectionLevel is called.

const DtRwPropertiesMap* DtEngineeringObjectSensor::myEnvAttritionProp
protected

These properties gets cached in the tick function so it doesn't need to be looked up every time detectionLevel is called.


The documentation for this class was generated from the following file:

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)