DtActiveSonarSensor Class Reference

Inheritance diagram for DtActiveSonarSensor:

Public Member Functions
	DtActiveSonarSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtActiveSonarSensor ()
	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	tick ()
	Overridden from base class to update myLocalSensorPosition (using localSensorPosition()) at the start of each tick.
Public Member Functions inherited from DtPassiveSonarSensor
	DtPassiveSonarSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtPassiveSonarSensor ()
	destructor
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 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	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 DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
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 DtInputPort *	lookupInputPort (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 DtOutputPort *	lookupOutputPort (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 DtInputPortGroup *	lookupInputPortGroup (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 DtOutputPortGroup *	lookupOutputPortGroup (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
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () 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 DtSimResourceManager &	resourceManager ()
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 DtReaderWriter &	operator= (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 aliasContainer &	aliases () 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Member Functions inherited from DtPassiveSonarSensor
static void	setSonarDepthCallback (DtSimMessage *msg, void *usrData)

Protected Member Functions
virtual bool	detectObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo)
	Overridden from DtSignatureObjectSensor to check if beam emitter beam is turned on or off.
virtual bool	continueDetectingObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified)
	Overridden from DtSignatureObjectSensor to check if beam emitter beam is turned on or off.
virtual const char *	defaultPSRType () const
virtual void	createAndInitActiveSonarSystem ()
	Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.
virtual void	destroyActiveSonarSystem ()
	Removes the active sonar system.
virtual void	processSetActiveSonarMode (DtSimMessage *msg)
	Calls setEmitterSystemOn() with the value specified in the message if the message matches our emitter system ID.
virtual void	processRequestActiveSonarModes (DtString receiver, DtString sender, bool isEchelonId, const DtVrfObjectMessage *msg)
virtual void	updateActiveSonarMode (const DtString modeToUse="")
	If modeToUse is empty, finds the right descriptor mode entry based on the value specified in the PSR, then based on active-by-default in the descriptor.
virtual void	timedTick ()
	See if sonar system should be initialized and created.
Protected Member Functions inherited from DtPassiveSonarSensor
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 DtObjectSensorPSR *	createPSR ()
	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.

Static Protected Member Functions
static void	setActiveSonarModeCallback (DtSimMessage *msg, void *usrData)
	Static callback method for setEmitter messages.
static void	requestActiveSonarModesCallback (const DtVrfObjectMessage *msg, void *usr)

Protected Attributes
DtVrfActiveSonarSystem *	myActiveSonarSystem
	Contains the active sonar system publisher.
DtActiveSonarSensorPSR *	myActiveSonarSensorPSR
	DtObjectSensor's myProcessState cast to our PSR type.
DtActiveSonarSensorDescriptor *	myDescriptor
DtU8	myActiveSonarSystemId
bool	myInitializeSonar
Protected Attributes inherited from DtPassiveSonarSensor
const DtPassiveSonarSensorDescriptor *	myPassiveSonarSensorDescriptor
DtPassiveSonarSensorPSR *	myPassiveSonarPSR
	DtObjectSensor's myProcessState cast to our PSR type.
Protected Attributes inherited from DtSignatureObjectSensor
const DtSignatureObjectSensorDescriptor *	mySignatureObjectSensorDescriptor
DtSymbolString	mySensorDomain
DtVector	myLocalSensorPosition
DtSignatureDetectLevelDeterminator *	myDetectionLevelDeterminator
Protected Attributes inherited from DtObjectSensor
DtManagedObjectListConstPtr	myDetectableObjectList
const DtObjectSensorDescriptor *	myObjectSensorDescriptor
DtObjectSensorPSR *	myProcessState
	Container for state data associated with this component.
DtObjectSensorMonitor *	myMonitor
	Sends out sensor contact information to the GUI if the GUI or other application has requested the information.
DtSpatialFilterEvaluator *	mySensorGeometryEvaluator
const DtVrfObject *	myMutableObjectCached
	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.
DtSensorContactListOutputPort *	myDetectedObjectListPort
	Outputs: Output Port Name: detected-objects Output Port Description: The list of contacts detected by this sensor.
DtObjectTypesListMultiInputPort *	myObjectsToDetectInputPort
	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.
DtInputPortGroup *	mySensorOffsetInputPortGroup
	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.
DtOrientationInputPort *	myOrientationInputPort
	Input Port Name: orientation Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted.
DtVectorInputPort *	myPositionInputPort
	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
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	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 DtComponentDescriptor *	myComponentDescriptor
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
	DtActiveSonarSensor ()
	default constructor; not implemented
	DtActiveSonarSensor (const DtActiveSonarSensor &orig)
	copy constructor; not implemented
const DtActiveSonarSensor &	operator= (const DtActiveSonarSensor &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 Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Constructor & Destructor Documentation

DtActiveSonarSensor::DtActiveSonarSensor ( )

private

default constructor; not implemented

DtActiveSonarSensor::DtActiveSonarSensor ( const DtActiveSonarSensor &  orig )

private

copy constructor; not implemented

DtActiveSonarSensor::DtActiveSonarSensor	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtActiveSonarSensor::~DtActiveSonarSensor ( )

virtual

destructor

Member Function Documentation

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

private

assignment operator; not implemented

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

virtual DtString DtActiveSonarSensor::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

DtRadarObjectSensorType

Reimplemented from DtPassiveSonarSensor.

virtual int DtActiveSonarSensor::sensorType ( ) const

virtual

Returns DtSensorTypeRadar.

Reimplemented from DtPassiveSonarSensor.

virtual void DtActiveSonarSensor::tick ( )

virtual

Overridden from base class to update myLocalSensorPosition (using localSensorPosition()) at the start of each tick.

It then calls DtObjectSensor::tick.

Reimplemented from DtSignatureObjectSensor.

static DtSimComponent* DtActiveSonarSensor::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

Reimplemented from DtPassiveSonarSensor.

virtual bool DtActiveSonarSensor::detectObject ( DtVrfObject *  object, DtRwSensorContactInfo *  contactInfo  )

protectedvirtual

Overridden from DtSignatureObjectSensor to check if beam emitter beam is turned on or off.

Returns

DtSignatureObjectSensor::dectedObject() if beam is on, otherwise false.

Reimplemented from DtPassiveSonarSensor.

virtual bool DtActiveSonarSensor::continueDetectingObject ( DtVrfObject *  object, DtRwSensorContactInfo *  contactInfo, bool &  contactInfoModified  )

protectedvirtual

Overridden from DtSignatureObjectSensor to check if beam emitter beam is turned on or off.

Returns

DtSignatureObjectSensor::continueDetectingObject() if beam is on, otherwise false.

Reimplemented from DtPassiveSonarSensor.

virtual const char* DtActiveSonarSensor::defaultPSRType ( ) const

protectedvirtual

Returns

DtVrfActiveSonarSensorProcessStateRepositoryType.

Reimplemented from DtPassiveSonarSensor.

virtual void DtActiveSonarSensor::createAndInitActiveSonarSystem ( )

protectedvirtual

Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.

Sets the emitter system data from the descriptor. Registers for setEmitter message callbacks.

virtual void DtActiveSonarSensor::destroyActiveSonarSystem ( )

protectedvirtual

Removes the active sonar system.

static void DtActiveSonarSensor::setActiveSonarModeCallback ( DtSimMessage *  msg, void *  usrData  )

staticprotected

Static callback method for setEmitter messages.

Calls processSetActiveSonarMode().

virtual void DtActiveSonarSensor::processSetActiveSonarMode ( DtSimMessage *  msg )

protectedvirtual

Calls setEmitterSystemOn() with the value specified in the message if the message matches our emitter system ID.

static void DtActiveSonarSensor::requestActiveSonarModesCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

virtual void DtActiveSonarSensor::processRequestActiveSonarModes ( DtString  receiver, DtString  sender, bool  isEchelonId, const DtVrfObjectMessage *  msg  )

protectedvirtual

virtual void DtActiveSonarSensor::updateActiveSonarMode ( const DtString  modeToUse = "" )

protectedvirtual

If modeToUse is empty, finds the right descriptor mode entry based on the value specified in the PSR, then based on active-by-default in the descriptor.

Else If modeToUse is "first-enabled-mode", finds the first descriptor mode entry that has beams. Else finds the descriptor mode entry named by modeToUse.

Once the right mode is found, it is set in the PSR. It is also set in the system, if the system exists.

virtual void DtActiveSonarSensor::timedTick ( )

protectedvirtual

See if sonar system should be initialized and created.

Reimplemented from DtSimComponent.

Member Data Documentation

DtVrfActiveSonarSystem* DtActiveSonarSensor::myActiveSonarSystem

protected

Contains the active sonar system publisher.

DtActiveSonarSensorPSR* DtActiveSonarSensor::myActiveSonarSensorPSR

protected

DtObjectSensor's myProcessState cast to our PSR type.

This class will not new or delete this object. Base class does that.

DtActiveSonarSensorDescriptor* DtActiveSonarSensor::myDescriptor

protected

DtU8 DtActiveSonarSensor::myActiveSonarSystemId

protected

bool DtActiveSonarSensor::myInitializeSonar

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/activeSonarSensor.h