vrforces5.1.1/classref/passive_sonar_sensor_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2012 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/


 #pragma once


 #include "vrfmodel/vrfmodelDefines.h"

 #include "vrfmodel/signatureObjectSensor.h"


 class DtVrfEmitterSystem;

 class DtPassiveSonarSensorDescriptor;

 class DtPassiveSonarSensorPSR;

 class DtSimMessage;

 class DtVrfObjectMessage;

 class DtVrfObjectCommunicationInterface;


 class DT_DLL_vrfmodel DtPassiveSonarSensor : public DtSignatureObjectSensor

 {

 private:

    DtPassiveSonarSensor();


    DtPassiveSonarSensor(const DtPassiveSonarSensor &

       orig);


    const DtPassiveSonarSensor & operator=(const

       DtPassiveSonarSensor & orig);


 public:


    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;


    static void setSonarDepthCallback(DtSimMessage * msg, void * usrData);

    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;


    static DtSimComponent * creator(const DtString& name,

       DtLocalObject* owner,

       DtSimulationServices* simManager,

       DtComponentDescriptor* desc = 0,

       DtReaderWriterRegistry* parentRegistry = 0);


 protected:

    virtual bool detectObject(DtSimObjectReference object, DtRwSensorContactInfo* contactInfo) override;


    virtual ContinueDetectingResult continueDetectingObject(DtSimObjectReference object,

       DtRwSensorContactInfo* contactInfo,

       bool& contactInfoModified) override;


    virtual const char* defaultPSRType() const;


 protected:


    virtual bool sonarCanDetectObjects() const;


 protected:

    const DtPassiveSonarSensorDescriptor* myPassiveSonarSensorDescriptor;

    DtPassiveSonarSensorPSR* myPassiveSonarPSR;

 };

DtSignatureObjectSensor::sensorType
virtual int sensorType() const
Returns the enumerated type of this sensor. It is based on the sensor domain string. &quot;radar&quot; maps to DtSenorTypeRadar. &quot;visual&quot; maps to DtSensorTypeVisual. &quot;sonar&quot; maps to DtSensorTypeSonar. &quot;infrared&quot; maps to DtSensorTypeInfrared. Anything else maps to DtSensorTypeUnknown.

DtSignatureObjectSensor::operator=
const DtSignatureObjectSensor & operator=(const DtSignatureObjectSensor &orig)
assignment operator; not implemented

DT_DLL_vrfmodel
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24

vrfmodelDefines.h

DtSignatureObjectSensor::init
virtual bool init()
Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry(...

DtPassiveSonarSensor::myPassiveSonarPSR
DtPassiveSonarSensorPSR * myPassiveSonarPSR
DtObjectSensor&#39;s myProcessState cast to our PSR type. This class will not new or delete this object...
Definition: passiveSonarSensor.h:117

DtSimObjectReference
The DtSimObjectReference is a shared pointer that can be used amongst many object for access to the u...
Definition: simObjectReference.h:26

DtComponentDescriptor
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

DtSignatureObjectSensor::type
virtual const char * type() const
Returns a string identifies the class type of component. Type values are defined in compTypes...

DtRwSensorContactInfo
This class represents the data gathered by a sensor about a particular single sensor contact...
Definition: rwSensorContactInfo.h:68

DtSignatureObjectSensor::apparentSignature
virtual double apparentSignature(DtSimObjectReference object, bool losValueIfTerrainUnavailable, double sensorSensitivity) const
Returns the apparent signature of the specified object using sensorSignatureManager::apparentObjectSi...

DtPassiveSonarSensorPSR
Process State Repository for the DtPassiveRadarSensor component.
Definition: passiveSonarSensorPSR.h:16

DtVrfEmitterSystem
DtVrfEmitterSystem manages a VR-Link emitter system publisher, and sets all the values associated wit...
Definition: vrfEmitterSystem.h:40

DtVector

DtPassiveSonarSensorDescriptor
DtPassiveSonarSensorDescriptor; descriptor for the DtPassiveSonarSensor component.
Definition: passiveSonarSensorDescriptor.h:19

DtSignatureObjectSensor
A sensor component which uses the VR-Forces Sensor Signature model for detecting object.
Definition: signatureObjectSensor.h:41

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

DtSimMessage
File: simMsg.h.
Definition: simMessage.h:35

DtVrfObjectMessage
The base class for all messages to/from a specific DtVrfObject. Various subclasses of this class will...
Definition: vrfObjectMessage.h:30

DtObjectSensor::ContinueDetectingResult
ContinueDetectingResult
Definition: objectSensor.h:69

DtSimulationServices
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:95

DtSimComponent
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:91

DtVrfObjectCommunicationInterface
The central class of a DtLocalObject for all communications to and from the object. This class manages all communications on a specific DtLocalObject, though both simulation internal communication, and communication though the simulated radios of the object. All communication is done though the use of the DtVrfObjectMessage class and its subclasses. Callbacks can be registered on this interface which will be called on receipt of a message by this entity. Messages can be sent from this entity by using the message sending functions. These messages may be sent though the SimInternal message mechanism, or the radio message system. Radios will not exist until createRadiosFromDescriptorList() or createRadiosFromDescriptorList(const DtRadioDescriptorList&amp; descList) is called.
Definition: vrfObjectCommunicationInterface.h:40

DtSignatureObjectSensor::detectObject
virtual bool detectObject(DtSimObjectReference object, DtRwSensorContactInfo *contactInfo) override
Returns true if object is detected. Calls apparentSignature to determine what the object&#39;s signature ...

DtPassiveSonarSensor::myPassiveSonarSensorDescriptor
const DtPassiveSonarSensorDescriptor * myPassiveSonarSensorDescriptor
Definition: passiveSonarSensor.h:114

signatureObjectSensor.h

DtString

DtSignatureObjectSensor::continueDetectingObject
virtual ContinueDetectingResult continueDetectingObject(DtSimObjectReference object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified) override
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.

DtPassiveSonarSensor
DtPassiveSonarSensor.
Definition: passiveSonarSensor.h:31

DtLocalObject
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86

DtSignatureObjectSensor::defaultPSRType
virtual const char * defaultPSRType() const