VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtPassiveSonarSensor Class Reference

DtPassiveSonarSensor. More...

Inheritance diagram for DtPassiveSonarSensor:
Inheritance graph
[legend]

Public Member Functions

 DtPassiveSonarSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtPassiveSonarSensor ()
 destructor
virtual bool init ()
 Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry().
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual int sensorType () const
 Returns DtSensorTypeRadar.
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 (DtVrfObject *object, bool losValueIfTerrainUnavailable) const
 Override to use sonar depth instead of sensor position if a depth has been set.
- Public Member Functions inherited from DtSignatureObjectSensor
 DtSignatureObjectSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtSignatureObjectSensor ()
 destructor
virtual void tick ()
 Overridden from base class to update myLocalSensorPosition (using localSensorPosition()) at the start of each tick.
virtual int determineForceType (DtVrfObject *object, DtRwSensorContactInfo *contactInfo)
 Determines the force type for this object based on the sensor contact info for it.
- Public Member Functions inherited from DtObjectSensor
 DtObjectSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtObjectSensor ()
 destructor
virtual bool tickWhileDestroyed () const
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_System * coordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System * coordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual void enable ()
 Is this component enabled or not.
virtual void disable ()
 Is this component enabled or not.
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStream & objectConsoleDebug () const
virtual DtOutputStream & objectConsoleVerbose () const
virtual DtOutputStream & objectConsoleInfo () const
virtual DtOutputStream & objectConsoleWarn () const
virtual DtOutputStream & objectConsoleError () const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static void setSonarDepthCallback (DtSimMessage *msg, void *usrData)
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual bool detectObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo)
 Overridden from DtSignatureObjectSensor to check if the current speed is greater than the maximum effective speed.
virtual bool continueDetectingObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified)
 Overridden from DtSignatureObjectSensor to check if the current speed is greater than the maximum effective speed.
virtual const char * defaultPSRType () const
virtual bool sonarCanDetectObjects () const
 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.
- Protected Member Functions inherited from DtSignatureObjectSensor
virtual double minimumSignatureThreshold () const
virtual bool determineIdentificationLevel (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, double appSignature, int &level, bool &contactInfoModified)
 Determine varying levels of detection.
virtual void updateSensorContactInfo (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, int updateLevel)
virtual void addDetectionError (DtRwSensorContactInfo *info, int level)
 Uses the sensor positional error set in the sensor descriptor to add error to the contact information.
virtual bool objectInSector (const DtVrfObject *object) const
virtual DtVector localSensorPosition () const
 Overridden to use the offset from the descriptor if the position port is not connected.
- Protected Member Functions inherited from DtObjectSensor
virtual bool createPortGroups ()
 Creates and initializes port groups.
virtual bool createPorts ()
 Creates the target list port.
virtual DtObjectSensorPSRcreatePSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual void updateDetectableObjectsList ()
 Sets up myDetectableObjectList as a list that contains all entity types/forces specified in both the descriptor and the myObjectsToDetectInputPort input port.
virtual bool initSensorGeometry ()
 Creates the geometry evaluator based on the sensor-geometry entry in the descriptor, and the sensor geometry evaluator factory.
virtual void setupGeometryForDetection ()
 Sets up the current sensor geometry evaluator with the current position and orientation of the sensor.
virtual DtTaitBryan localSensorOrientation () const
virtual bool processObjects ()
 Checks detectability of each of the detectable objects.
virtual bool objectWithinSensorGeometry (DtVrfObject *object) const
virtual double rangeSquaredToObject (const DtVrfObject *object) const
virtual double rangeToObject (const DtVrfObject *object) const
virtual void clearObjectRangeCache () const
 Invalidates the current object range cache.
virtual void printTargets () const
 Prints the current target list to the console.
virtual void updateDetectedObjectListPort ()
 Clears the list port, then adds all target infos from the previous target list in the PSR, and sends the data.
virtual bool createAndInitSensorMonitor ()
 Creates a DtObjectSensorMonitor, and calls init() on it.
virtual bool objectInDetectableList (DtVrfObject *) const
 Returns true if the object is in the myDetectableObjectList.
virtual void processHostilitiesChanged (DtU8 force)
DtCompositePredicate objectTypeForcePredicate (const DtObjectType &, const DtNLengthIntegerVector &forceTypes)
 Specifies force types as s DtNLenghtIntegerVector.
DtCompositePredicate objectTypeForcePredicate (const DtObjectType &, const std::list< DtU8 > &forceTypes)
 Specifies force types as a std::list.
- Protected Member Functions inherited from DtSimComponent
bool testInvariant () const
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

const
DtPassiveSonarSensorDescriptor
myPassiveSonarSensorDescriptor
DtPassiveSonarSensorPSRmyPassiveSonarPSR
 DtObjectSensor's myProcessState cast to our PSR type.
- Protected Attributes inherited from DtSignatureObjectSensor
const
DtSignatureObjectSensorDescriptor
mySignatureObjectSensorDescriptor
DtSymbolString mySensorDomain
DtVector myLocalSensorPosition
DtSignatureDetectLevelDeterminatormyDetectionLevelDeterminator
- Protected Attributes inherited from DtObjectSensor
DtManagedObjectListConstPtr myDetectableObjectList
const DtObjectSensorDescriptormyObjectSensorDescriptor
DtObjectSensorPSRmyProcessState
 Container for state data associated with this component.
DtObjectSensorMonitormyMonitor
 Sends out sensor contact information to the GUI if the GUI or other application has requested the information.
DtSpatialFilterEvaluatormySensorGeometryEvaluator
const DtVrfObjectmyMutableObjectCached
 The VrfObject whose range is currently cached.
bool myMutableObjectRangeCalculated
 Keeps track of whether the range has been calculated for the current cached object.
double myMutableObjectRangeCache
 The current range to the cached object, if calculated.
bool myMutableObjectRangeSquaredCalculated
 Keeps track of whether the range squared has been calculated for the current cached object.
double myMutableObjectRangeSquaredCache
 The current range squared to the cached object, if calculated.
DtSensorContactListOutputPortmyDetectedObjectListPort
 Outputs: Output Port Name: detected-objects
Output Port Description: The list of contacts detected by this sensor.
DtObjectTypesListMultiInputPortmyObjectsToDetectInputPort
 Inputs: DtObjectTypesListMultiInputPort : object-types-to-detect Input Port Name: object-types-to-detect
Input Port Description: List of contacts to be considered for target selection.
DtInputPortGroupmySensorOffsetInputPortGroup
 Input Port Group Name: sensor-offset
Input Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity's position.
DtOrientationInputPortmyOrientationInputPort
 Input Port Name: orientation
Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted.
DtVectorInputPortmyPositionInputPort
 Input Port Name: position
Input Port Description: Specifies the position of the sensor in body coordinates relative to the entity which it is mounted on.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs.
DtListItem * myListItem
DtInputPortMap myInputPortList
DtOutputPortMap myOutputPortList
DtInputPortGroupMap myInputPortGroupList
DtOutputPortGroupMap myOutputPortGroupList
int myPriority
double myMinTickPeriod
double myMinTickPeriodVariance
double myNextTickTime
double myLastTickSimTime
double myDT
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not.
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptormyComponentDescriptor
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

Private Member Functions

 DtPassiveSonarSensor ()
 default constructor; not implemented
 DtPassiveSonarSensor (const DtPassiveSonarSensor &orig)
 copy constructor; not implemented
const DtPassiveSonarSensoroperator= (const DtPassiveSonarSensor &orig)
 assignment operator; not implemented

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::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)
 If who were hostile towards has changed we will need to update our myDetectableObjectList.
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtPassiveSonarSensor.

Uses Descriptor Type: DtPassiveSonarSensorDescriptor

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,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject 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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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

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 ( DtVrfObject object,
bool  losValueIfTerrainUnavailable 
) const
virtual

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,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject 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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual bool DtPassiveSonarSensor::detectObject ( DtVrfObject object,
DtRwSensorContactInfo contactInfo 
)
protectedvirtual

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

Reimplemented from DtSignatureObjectSensor.

Reimplemented in DtActiveSonarSensor.

virtual bool DtPassiveSonarSensor::continueDetectingObject ( DtVrfObject object,
DtRwSensorContactInfo contactInfo,
bool contactInfoModified 
)
protectedvirtual

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

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:

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)