A sensor class designed to be used for passive sonar sensors. This sensor only operates if it is currently submerged in the water, and it also responds to the "Set Sonar Depth" message to adjust the depth of the sonar sensor. The sonar depth is the offset of the sonar sensor location below the entity that it is attached to. This can be used both on aircraft (dipping sonars) and on ships and submarines.

Uses Descriptor Type: DtPassiveSonarSensorDescriptor

Inheritance diagram for DtPassiveSonarSensor:

[legend]

Public Member Functions
	DtPassiveSonarSensor (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtPassiveSonarSensor ()

virtual bool	init ()

virtual const char *	type () const

virtual int	sensorType () const

virtual void	processSetSonarDepth (DtSimMessage *msg)

virtual double	sonarDepth () const

virtual void	setSonarDepth (double depth)

virtual void	setSonarToEntityDepth ()

virtual DtVector	localSonarLocation () const

virtual bool	sonarInWater () const

double	apparentSignature (DtSimObjectReference object, bool losValueIfTerrainUnavailable, double sensorSensitivity) const override

Public Member Functions inherited from DtSignatureObjectSensor
	DtSignatureObjectSensor (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSignatureObjectSensor ()

virtual void	initSensorFieldOfView ()

virtual void	tick ()

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)

Public Member Functions inherited from DtObjectSensor
	DtObjectSensor (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtObjectSensor ()

virtual bool	postAddComponentsInit ()

virtual void	preFirstTickInit ()

virtual bool	tickWhileDestroyed () const

virtual void	enable ()

virtual void	disable ()

virtual void	setIsEnabled (bool yesNo)

virtual void	setTypesToDetectForTask (const DtRwObjectTypeList &objectTypes)

virtual void	clearTypesToDetectForTask ()

virtual const DtRwObjectTypeList &	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 ()

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)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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 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 void	setSonarDepthCallback (DtSimMessage msg, void usrData)

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

Static Public Member Functions inherited from DtSignatureObjectSensor
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	detectObject (DtSimObjectReference object, DtRwSensorContactInfo *contactInfo) override

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

virtual const char *	defaultPSRType () const

virtual bool	sonarCanDetectObjects () const

Protected Member Functions inherited from DtSignatureObjectSensor
virtual bool	createPortGroups ()

virtual bool	createPorts ()

virtual double	minimumSignatureThreshold (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 ()

virtual double	suppressionEffects () const

virtual const DtString &	probabilityString () 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 DtPassiveSonarSensorDescriptor *	myPassiveSonarSensorDescriptor

DtPassiveSonarSensorPSR *	myPassiveSonarPSR

Protected Attributes inherited from DtSignatureObjectSensor
const DtSignatureObjectSensorDescriptor *	mySignatureObjectSensorDescriptor

DtSymbolString	mySensorDomain

DtVector	myLocalSensorPosition

double	mySensitivity

DtVrfSensorFieldOfView *	myFieldOfView

DtSignatureDetectLevelDeterminator *	myDetectionLevelDeterminator

DtSignatureObjectSensorPSR *	mySignatureSensorPSR

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

DtBoost::shared_ptr < DtProcessObjectsState >	myProcessObjectsState

DtSensorContactListOutputPort *	myDetectedObjectListPort

DtObjectTypesListMultiInputPort *	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

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
	DtPassiveSonarSensor ()

	DtPassiveSonarSensor (const DtPassiveSonarSensor &orig)

const DtPassiveSonarSensor &	operator= (const DtPassiveSonarSensor &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

DtPassiveSonarSensor::DtPassiveSonarSensor ( )

private

default constructor; not implemented

DtPassiveSonarSensor::DtPassiveSonarSensor ( const DtPassiveSonarSensor & orig )

private

copy constructor; not implemented

DtPassiveSonarSensor::DtPassiveSonarSensor	(	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 DtPassiveSonarSensor::~DtPassiveSonarSensor ( )

virtual

destructor

Member Function Documentation

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

private

assignment operator; not implemented

virtual bool DtPassiveSonarSensor::init ( )

virtual

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

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual const char* DtPassiveSonarSensor::type ( ) const

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.

Returns: DtPassiveSonarSensorType

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual int DtPassiveSonarSensor::sensorType ( ) const

virtual

Returns DtSensorTypeRadar.

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

static void DtPassiveSonarSensor::setSonarDepthCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

virtual void DtPassiveSonarSensor::processSetSonarDepth ( DtSimMessage * msg )

virtual

virtual double DtPassiveSonarSensor::sonarDepth ( ) const

virtual

virtual void DtPassiveSonarSensor::setSonarDepth ( double depth )

virtual

virtual void DtPassiveSonarSensor::setSonarToEntityDepth ( )

virtual

virtual DtVector DtPassiveSonarSensor::localSonarLocation ( ) const

virtual

virtual bool DtPassiveSonarSensor::sonarInWater ( ) const

virtual

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

overridevirtual

Override to use sonar depth instead of sensor position if a depth has been set.

Reimplemented from DtSignatureObjectSensor.

static DtSimComponent* DtPassiveSonarSensor::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 DtPassiveSonarSensor::detectObject	(	DtSimObjectReference	object,
		DtRwSensorContactInfo *	contactInfo
	)

overrideprotectedvirtual

Overridden from DtSignatureObjectSensor to check if the current speed is greater than the maximum effective speed.

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

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

overrideprotectedvirtual

Overridden from DtSignatureObjectSensor to check if the current speed is greater than the maximum effective speed.

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual const char* DtPassiveSonarSensor::defaultPSRType ( ) const

protectedvirtual

Returns: DtVrfPassiveSonarSensorProcessStateRepositoryType.

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual bool DtPassiveSonarSensor::sonarCanDetectObjects ( ) const

protectedvirtual

Returns true if: 1) the entity is moving below the maximum effective speed 2) the sonar is either at a specified depth or usable while retracted 3) the sonar is in water or underneath an unspecified surface.

Member Data Documentation

const DtPassiveSonarSensorDescriptor* DtPassiveSonarSensor::myPassiveSonarSensorDescriptor

protected

DtPassiveSonarSensorPSR* DtPassiveSonarSensor::myPassiveSonarPSR

protected

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

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmodel/passiveSonarSensor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation