DtSignatureObjectSensor Class Reference

A sensor component which uses the VR-Forces Sensor Signature model for detecting object.

End User Description: This sensor implements the VR-Forces Sensor Signature model in any sensor domain. This sensor can act in any of the sensor domains by specifying the domain name in the descriptor. Objects are detected based on their signature value in the chosen domain, and using the DtPhysicalWorld to propagate the signature though the environment to this sensor's location. Probability of detection is then based on the detection files specified in the descriptor for this sensor. Objects with a higher apparent signature are easier to detect than those with lower signature. This sensor component extends the base DtObjectSensor, so all of the capability for publishing sensor contacts to the GUI is used by this component.

Uses Descriptor Type: DtSignatureObjectSensorDescriptor

Inheritance diagram for DtSignatureObjectSensor:

Public Member Functions
	DtSignatureObjectSensor (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSignatureObjectSensor () override
virtual bool	init () override
virtual void	initSensorFieldOfView ()
virtual const char *	type () const override
virtual const char *	defaultPSRType () const override
virtual int	sensorType () const override
virtual void	tick () override
virtual int	determineForceType (const DtSimObject *object, DtRwSensorContactInfo *contactInfo)
virtual double	determineRadius (const DtSimObject *object, DtRwSensorContactInfo *contactInfo)
virtual void	zoomSensor (double zoomLevel)
virtual void	setSensorEnabled (bool enabled) 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 DtRwEntityTypeList &	typesToDetectForTask () const
virtual bool	setTypesToDetectAttribute (DtReaderWriter *val)
virtual bool	clearTypesToDetect (DtReaderWriter *val)
virtual DtReaderWriter *	getSensorPositionAttribute ()
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)
DtComponentSystem *	parentSystem () 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 DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
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 DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (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
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
virtual void	onRestore ()
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
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 DtSimResourceManager &	resourceManager ()
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 DtReaderWriter &	operator= (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 aliasContainer &	aliases () 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 char *	readerWriterType () const
virtual const char *	xmlType () 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 DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () 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 DtSimComponent *	creator (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 DtReaderWriter *	getSensorPositionAttribute (void *ctrlr)
static DtSimComponent *	creator (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 DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (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 char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual bool	createPortGroups () override
virtual bool	createPorts () override
virtual bool	detectObject (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo) override
virtual ContinueDetectingResult	continueDetectingObject (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified) override
virtual double	minimumSignatureThreshold (double sensorSensitivity) const
virtual double	apparentSignature (DtSimObjectReference object, bool losValueIfTerrainUnavailable, double sensorSensitivity) const
virtual bool	detectedThisPeriod (double appSignature) const
virtual bool	determineIdentificationLevel (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, double appSignature, int &level, bool &contactInfoModified)
virtual bool	updateContactPositionAndOrientation (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, const int updateLevel)
virtual bool	updateSensorContactInfo (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, const int updateLevel)
virtual void	addDetectionError (DtRwSensorContactInfo *info, int level)
virtual double	sensitivity () const
virtual double	sensitivityModifier () const
virtual bool	objectInSector (const DtSimObject *object) const
virtual double	windEffects () const
virtual double	precipitationEffects () const
virtual void	setupGeometryForDetection () override
virtual double	suppressionEffects () const
virtual const DtString &	probabilityString () const
virtual DtTerrainCategoryMask	terrainCategoryMask () const
Protected Member Functions inherited from DtObjectSensor
virtual DtObjectSensorPSR *	createPSR ()
virtual void	initSensorRangeRing ()
virtual void	updateDetectableObjectsList ()
virtual bool	initSensorGeometry ()
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
DtVrfProcessStateRepository *	createComponentPsr (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
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (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
const DtSignatureObjectSensorDescriptor *	mySignatureObjectSensorDescriptor
DtSymbolString	mySensorDomain
DtVector	myLocalSensorPosition
double	mySensitivity
DtVrfSensorFieldOfView *	myFieldOfView
DtSignatureDetectLevelDeterminator *	myDetectionLevelDeterminator
DtSignatureObjectSensorPSR *	mySignatureSensorPSR
Ports and Port Groups
DtAnalogInputPort *	myZoomLevelPort
DtIntegerInputPort *	myFieldOfViewColorPort
DtInputPortGroup *	mySensorFieldOfViewLimitsPortGroup
DtAnalogInputPort *	myMinFieldOfViewAzimuthPort
DtAnalogInputPort *	myMaxFieldOfViewAzimuthPort
DtAnalogInputPort *	myMinFieldOfViewElevationPort
DtAnalogInputPort *	myMaxFieldOfViewElevationPort
Protected Attributes inherited from DtObjectSensor
DtManagedObjectListConstPtr	myDetectableObjectList
const DtObjectSensorDescriptor *	myObjectSensorDescriptor
DtObjectSensorPSR *	myProcessState
std::vector < DtObjectSensorMonitor * >	myMonitors
DtSpatialFilterEvaluator *	mySensorGeometryEvaluator
DtForceType	myForceType
const DtSimObject *	myMutableObjectCached
bool	myMutableObjectRangeCalculated
double	myMutableObjectRangeCache
bool	myMutableObjectRangeSquaredCalculated
double	myMutableObjectRangeSquaredCache
bool	myGeometrySetup
bool	myPrep_invokeNewContactCallbacks
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
std::shared_ptr < DtProcessObjectsState >	myProcessObjectsState
DtSensorContactListOutputPort *	myDetectedObjectListPort
DtEntityTypesListMultiInputPort *	myObjectsToDetectInputPort
DtInputPortGroup *	mySensorOffsetInputPortGroup
DtOrientationInputPort *	myOrientationInputPort
DtVectorInputPort *	myPositionInputPort
DtStringInputPort *	myTargetObjectInputPort
DtVectorInputPort *	myTargetLocationInputPort
DtIntegerInputPort *	myTrackingModeInputPort
DtBooleanInputPort *	myTargetAcquiredInputPort
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
bool	myLocalDebug
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
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtSignatureObjectSensor ()
	DtSignatureObjectSensor (const DtSignatureObjectSensor &orig)
const DtSignatureObjectSensor &	operator= (const DtSignatureObjectSensor &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 DtSimComponentFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtSignatureObjectSensor::DtSignatureObjectSensor ( )

private

default constructor; not implemented

DtSignatureObjectSensor::DtSignatureObjectSensor ( const DtSignatureObjectSensor &  orig )

private

copy constructor; not implemented

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

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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 DtSignatureObjectSensor::~DtSignatureObjectSensor ( )

overridevirtual

destructor

Member Function Documentation

const DtSignatureObjectSensor& DtSignatureObjectSensor::operator= ( const DtSignatureObjectSensor &  orig )

private

assignment operator; not implemented

virtual bool DtSignatureObjectSensor::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.

Reimplemented in DtCounterBatteryRadarSensor, DtRadarObjectSensor, DtPassiveSonarSensor, DtSearchRescueSensor, and DtActiveSonarSensor.

virtual void DtSignatureObjectSensor::initSensorFieldOfView ( )

virtual

Creates a sensor field of view object which is published to the network. Details the orientation and width of the sensor's field of view.

virtual const char* DtSignatureObjectSensor::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

DtSignatureObjectSensorType

Reimplemented from DtObjectSensor.

Reimplemented in DtCounterBatteryRadarSensor, DtRadarObjectSensor, DtPassiveSonarSensor, DtSearchRescueSensor, and DtActiveSonarSensor.

virtual const char* DtSignatureObjectSensor::defaultPSRType ( ) const

overridevirtual

Returns

DtVrfSignatureObjectSensorProcessStateRepositoryType.

Reimplemented from DtObjectSensor.

Reimplemented in DtCounterBatteryRadarSensor, DtRadarObjectSensor, DtPassiveSonarSensor, and DtActiveSonarSensor.

virtual int DtSignatureObjectSensor::sensorType ( ) const

overridevirtual

Returns the enumerated type of this sensor. It is based on the sensor domain string. "radar" maps to DtSenorTypeRadar. "visual" maps to DtSensorTypeVisual. "sonar" maps to DtSensorTypeSonar. "infrared" maps to DtSensorTypeInfrared. Anything else maps to DtSensorTypeUnknown.

Reimplemented from DtObjectSensor.

Reimplemented in DtRadarObjectSensor, DtSearchRescueSensor, DtPassiveSonarSensor, and DtActiveSonarSensor.

virtual void DtSignatureObjectSensor::tick ( )

overridevirtual

Overridden from base class to update myLocalSensorPosition (using localSensorPosition()) at the start of each tick. It then calls DtObjectSensor::tick.

Reimplemented from DtObjectSensor.

Reimplemented in DtCounterBatteryRadarSensor, DtRadarObjectSensor, DtSearchRescueSensor, DtActiveSonarSensor, and DtPassiveSonarSensor.

virtual int DtSignatureObjectSensor::determineForceType ( const DtSimObject *  object, DtRwSensorContactInfo *  contactInfo  )

virtual

Determines the force type for this object based on the sensor contact info for it. Currently just uses the detection-level-to-set-force-type parameter from the sensor descriptor to determine at which identification level we would be able to know the force type of the object.

Reimplemented in DtRadarObjectSensor.

virtual double DtSignatureObjectSensor::determineRadius ( const DtSimObject *  object, DtRwSensorContactInfo *  contactInfo  )

virtual

Determines the radius of this object based on the sensor contact info for it. Currently just uses the detection-level-to-set-radius parameter from the sensor descriptor to determine at which identification level we would be able to know the radius of the object. Note: The radius is only used for aggregate objects!

virtual void DtSignatureObjectSensor::zoomSensor ( double  zoomLevel )

virtual

Zooms the sensor to the given zoom level.

virtual void DtSignatureObjectSensor::setSensorEnabled ( bool  enabled )

overridevirtual

Enables or disables this sensor.

Reimplemented from DtObjectSensor.

Reimplemented in DtRadarObjectSensor, and DtActiveSonarSensor.

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

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

Returns

New instance of this class.

virtual bool DtSignatureObjectSensor::createPortGroups ( )

overrideprotectedvirtual

Creates and initializes port groups.

Reimplemented from DtObjectSensor.

virtual bool DtSignatureObjectSensor::createPorts ( )

overrideprotectedvirtual

Overridden to create local ports.

Reimplemented from DtObjectSensor.

virtual bool DtSignatureObjectSensor::detectObject ( DtSimObjectReference  object, DtRwSensorContactInfo *  contactInfo  )

overrideprotectedvirtual

Returns true if object is detected. Calls apparentSignature to determine what the object's signature appears to this sensor based on distance and potentially other factors that could degrade the object's absolute signature. Once the apparent signature is determined the sensor will then call determineIdentificationLevel which will check this apparent signature to see if this sensor is capable of detecting it. If so returns true and creates a DtRwSensorContactInfo for it and return that in contactInfo.

Reimplemented from DtObjectSensor.

Reimplemented in DtRadarObjectSensor, DtPassiveSonarSensor, DtSearchRescueSensor, and DtActiveSonarSensor.

virtual ContinueDetectingResult DtSignatureObjectSensor::continueDetectingObject ( DtSimObjectReference  object, DtRwSensorContactInfo *  contactInfo, bool &  contactInfoModified  )

overrideprotectedvirtual

Same as detectObject except it is checking for objects we had previously detected. In this case the amount of time that this object has been detected by the sensor will be factored in when determining the identification level. Again returns true if the object is still detected and the contact info is updated. If there were changes in the contact info, contactInfoModified will be true.

Reimplemented from DtObjectSensor.

Reimplemented in DtRadarObjectSensor, DtPassiveSonarSensor, DtSearchRescueSensor, and DtActiveSonarSensor.

virtual double DtSignatureObjectSensor::minimumSignatureThreshold ( double  sensorSensitivity ) const

protectedvirtual

Returns

The minimum apparent signature that this sensor is capable of sensing. This is specified in the sensor's DtSignatureDetectLevelDeterminator. The minimal signature will be divided by the incoming sensitivity

virtual double DtSignatureObjectSensor::apparentSignature ( DtSimObjectReference  object, bool  losValueIfTerrainUnavailable, double  sensorSensitivity  ) const

protectedvirtual

Returns the apparent signature of the specified object using sensorSignatureManager::apparentObjectSignature. A DtSignaturePropagatorArgs class is instantiated that holds the object to be detected, the sensing object, the location we are sensing from and the minimum signature threshold below which there's no point in doing further checks.
The DtSensorSignatureMananger first gets the object's signature:
From the object's state repository, it gets the base signature (as given in the .entity parameter file, normally) and applies signature modifiers. The modifiers are listed in the platform .ope file, normally.
Next, the DtSensorSignatureMananger looks up the signature propagator for this domain and applies it. The propagator can reduce the signature based on distance from the observer, environmental conditions, etc. Propagator parameters are given in the physicalWorldParams.mtl file in the SMS.
The propagator function generally performs a normalization such that in ideal sensing conditions, it returns the target's signature divided by the range to target in km.

Parameters

losValueIfTerrainUnavailable	This parameter indicates what to do if the terrain database indicates that data is unavailable (hasn't been streamed/paged in yet). If true, the target can be seen though unavailable data, if false, the target cannot be seen though unavailable data areas.
sensorSensitivity	This parameter is modification factors to the sensor ability to sense. This will be applied to the minimum signature threshold to allow for detection of objects that might not normally meet the minimal signature

Reimplemented in DtCounterBatteryRadarSensor, and DtPassiveSonarSensor.

virtual bool DtSignatureObjectSensor::detectedThisPeriod ( double  appSignature ) const

protectedvirtual

Uses the detection probability table to determine if the object was detected during this detection period.

virtual bool DtSignatureObjectSensor::determineIdentificationLevel ( DtSimObjectReference  object, DtRwSensorContactInfo *  contactInfo, double  appSignature, int &  level, bool &  contactInfoModified  )

protectedvirtual

Determine varying levels of detection. Only know full truth at the highest level. Uses the apparent signature of the object and any previous contact info to determine what the combat identification level( CID ) of the object is. This is a measure of how well we know what this object is. A DtSignatureDetectLevelDeterminator is used to obtain the value. The longer the sensor looks at the object and the larger it's apparent signature the higher the identification level will be.

virtual bool DtSignatureObjectSensor::updateContactPositionAndOrientation ( DtSimObjectReference  object, DtRwSensorContactInfo *  contactInfo, const int  updateLevel  )

protectedvirtual

Called from updateSensorContactInfo, return true if changes made.

Reimplemented in DtCounterBatteryRadarSensor.

virtual bool DtSignatureObjectSensor::updateSensorContactInfo ( DtSimObjectReference  object, DtRwSensorContactInfo *  contactInfo, const int  updateLevel  )

protectedvirtual

Returns

True if changes were made to the sensor contact info.

Reimplemented in DtSearchRescueSensor.

virtual void DtSignatureObjectSensor::addDetectionError ( DtRwSensorContactInfo *  info, int  level  )

protectedvirtual

Uses the sensor positional error set in the sensor descriptor to add error to the contact information. Currently very simple linear relationship based on range. TBD.

virtual double DtSignatureObjectSensor::sensitivity ( ) const

protectedvirtual

The current sensitivity of the sensor. This value will be multiplied by the apparent signature to get the sensed signature. The base value is obtained from the sensor descriptor. It is then multiplied by the sensitivityModifier (below) and returned.

virtual double DtSignatureObjectSensor::sensitivityModifier ( ) const

protectedvirtual

The modifier for this sensor's sensitivity. A function of internal and external state. Includes modifiers for [aggregate] state properties for Posture and MOPP. Override this for sensor-specific modifiers.

Reimplemented in DtRadarObjectSensor.

virtual bool DtSignatureObjectSensor::objectInSector ( const DtSimObject *  object ) const

protectedvirtual

Returns

true if the specified object is in the host object's sector of responsibility. Calls down to DtVrfObjectStateRepository::inSOR

virtual double DtSignatureObjectSensor::windEffects ( ) const

protectedvirtual

How wind (if it does) effects the sensors.

virtual double DtSignatureObjectSensor::precipitationEffects ( ) const

protectedvirtual

How precipitation (if it does) effects the sensors.

virtual void DtSignatureObjectSensor::setupGeometryForDetection ( )

overrideprotectedvirtual

Sets up the current sensor geometry evaluator with the current position, orientation, and frustum of the sensor. Called once per detection cycle.

Reimplemented from DtObjectSensor.

virtual double DtSignatureObjectSensor::suppressionEffects ( ) const

protectedvirtual

How suppression effects sensors. Default is to make sensitivity 0.

virtual const DtString& DtSignatureObjectSensor::probabilityString ( ) const

protectedvirtual

virtual DtTerrainCategoryMask DtSignatureObjectSensor::terrainCategoryMask ( ) const

protectedvirtual

Returns

The terrain category mask to use for LOS checks.

Member Data Documentation

const DtSignatureObjectSensorDescriptor* DtSignatureObjectSensor::mySignatureObjectSensorDescriptor

protected

DtSymbolString DtSignatureObjectSensor::mySensorDomain

protected

DtVector DtSignatureObjectSensor::myLocalSensorPosition

protected

Computed once per tick:

double DtSignatureObjectSensor::mySensitivity

protected

DtVrfSensorFieldOfView* DtSignatureObjectSensor::myFieldOfView

protected

The field of view of the sensor.

DtSignatureDetectLevelDeterminator* DtSignatureObjectSensor::myDetectionLevelDeterminator

protected

DtSignatureObjectSensorPSR* DtSignatureObjectSensor::mySignatureSensorPSR

protected

DtObjectSensor's myProcessState cast to our PSR type. This class with not new or delete this object. Base class does that.

DtAnalogInputPort* DtSignatureObjectSensor::myZoomLevelPort

protected

Input Port Name: zoom-level
Input Port Description: Desired zoom level of the sensor.
Input Port Range: 1.0 to maximum zoom level
Input Group Parent:
.

DtIntegerInputPort* DtSignatureObjectSensor::myFieldOfViewColorPort

protected

Input Port Name: field-of-view-color
Input Port Description: Desired color for the sensor field of view.
Input Port Range: RGBA value
Input Group Parent:
.

DtInputPortGroup* DtSignatureObjectSensor::mySensorFieldOfViewLimitsPortGroup

protected

Input Port Group Name: sensor-field-of-view-limits
Input Port Group Description: Allows the actuator to communicate the azimuth and elevation limits of the sensor gimbal.

DtAnalogInputPort* DtSignatureObjectSensor::myMinFieldOfViewAzimuthPort

protected

Input Port Name: min-azimuth
Input Port Description: The minimum azimuth at which the field of view can aim.
Input Port Range: 0 - 2pi
Input Group Parent:
.

DtAnalogInputPort* DtSignatureObjectSensor::myMaxFieldOfViewAzimuthPort

protected

Input Port Name: max-azimuth
Input Port Description: The maximum azimuth at which the field of view can aim.
Input Port Range: 0 - 2pi
Input Group Parent:
.

DtAnalogInputPort* DtSignatureObjectSensor::myMinFieldOfViewElevationPort

protected

Input Port Name: min-elevation
Input Port Description: The minimum elevation at which the field of view can aim.
Input Port Range: -pi - pi
Input Group Parent:
.

DtAnalogInputPort* DtSignatureObjectSensor::myMaxFieldOfViewElevationPort

protected

Input Port Name: max-elevation
Input Port Description: The maximum elevation at which the field of view can aim.
Input Port Range: -pi - pi
Input Group Parent:
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/signatureObjectSensor.h