DtObjectSensorDescriptor Class Reference

DtObjectSensorDescriptor; descriptor for the DtObjectSensor component.

DtComponentDescriptor for the DtObjectSensor component. Includes types of objects to detect, geometry of covered area, force type of objects to detect, and whether to detect destroyed objects.

Inheritance diagram for DtObjectSensorDescriptor:

Public Member Functions
	DtObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtObjectSensorDescriptor (const DtObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtObjectSensorDescriptor &	operator= (const DtObjectSensorDescriptor &orig)
virtual	~DtObjectSensorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	detectOnlyHostileForces () const
virtual void	setDetectOnlyHostileForces (bool value)
virtual bool	detectOwnForce () const
virtual void	setDetectOwnForce (bool v)
virtual void	setDetectionTypes (const DtRwObjectTypeList &objectTypes)
virtual DtRwObjectTypeList &	detectionTypes ()
virtual const DtRwObjectTypeList &	detectionTypes () const
virtual void	setDetectDestroyedObjects (bool value)
virtual bool	detectDestroyedObjects () const
virtual DtReal	detectionPeriod () const
virtual void	setDetectionPeriod (DtReal detectionPeriod)
virtual DtReal	detectionPeriodVariance () const
virtual void	setDetectionPeriodVariance (DtReal detectionPeriodVariance)
virtual void	setAddSensorRangeRing (bool value)
virtual bool	addSensorRangeRing () const
virtual void	setWindDegradesSensorPerformanceWhenAbove (double)
virtual double	windDegradesSensorPerformanceWhenAbove () const
virtual void	setWindDegradesSensorPerformanceUntil (double)
virtual double	windDegradesSensorPerformanceUntil () const
virtual void	setWindDegradesSensorPerformanceBy (double)
virtual double	windDegradesSensorPerformanceBy () const
virtual void	setPrecipitationDegradesSensorPerformanceBy (double)
virtual double	precipitationDegradesSensorPerformanceBy () const
virtual void	setSuppressionDegradesSensorPerformanceBy (double)
virtual double	suppressionDegradesSensorPerformanceBy () const
virtual void	setZoomEnhancesSensitivity (bool v)
virtual bool	zoomEnhancesSensitivity () const
virtual DtRwSpatialFilterContainer *	sensorGeometry ()
virtual const DtRwSpatialFilterContainer *	sensorGeometry () const
virtual bool	canShowRadarCoverage () const
virtual void	setCanShowRadarCoverage (bool)
virtual double	radarCoverageAzimuthSamplingRate () const
virtual void	setRadarCoverageAzimuthSamplingRate (double)
virtual double	radarCoverageElevationSamplingRate () const
virtual void	setRadarCoverageElevationSamplingRate (double)
virtual double	radarCoveragePostSpacing () const
virtual void	setRadarCoveragePostSpacing (double)
virtual double	radarCoverageMovementDelta () const
virtual void	setRadarCoverageMovementDelta (double)
virtual double	radarCoverageOrientationDelta () const
virtual void	setRadarCoverageOrientationDelta (double)
virtual double	radarCoverageWaitTime () const
virtual void	setRadarCoverageWaitTime (double)
virtual double	radarCoverageHighResolutionRadius () const
virtual void	setRadarCoverageHighResolutionRadius (double radius)
virtual const DtVector &	sensorOffset () const
virtual void	setSensorOffset (const DtVector &sensorOffset)
virtual int	rangeId () const
virtual void	setRangeId (int rangeId)
virtual bool	rangeIdIsSpecified () const
virtual int	sensorTickTime () const
virtual void	setSensorTickTime (int ms)
virtual int	tickOverrunStrategy () const
virtual void	setTickOverrunStrategy (int s)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
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)
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	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	wasUpdatedSince (DtTime t) 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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myDetectOnlyHostileForces
DtRwBoolean	myDetectOwnForce
DtRwObjectTypeList	myDetectionTypes
DtRwBoolean	myDetectDestroyedObjects
DtRwReal	myDetectionPeriod
DtRwReal	myDetectionPeriodVariance
DtRwBoolean	myAddSensorRangeRing
DtRwReal	myWindDegradesSensorPerformanceWhenAbove
DtRwReal	myWindDegradesSensorPerformanceUntil
DtRwReal	myWindDegradesSensorPerformanceBy
DtRwReal	myPrecipitationDegradesSensorPerformanceBy
DtRwReal	mySuppressionDegradesSensorPerformanceBy
DtRwBoolean	myZoomEnhancesSensitivity
DtRwSpatialFilterContainer	mySensorGeometry
DtRwBoolean	myCanShowRadarCoverage
DtRwReal	myRadarCoverageAzimuthSamplingRate
DtRwReal	myRadarCoverageElevationSamplingRate
DtRwReal	myRadarCoveragePostSpacing
DtRwReal	myRadarCoverageMovementDelta
DtRwReal	myRadarCoverageOrientationDelta
DtRwReal	myRadarCoverageWaitTime
DtRwReal	myRadarCoverageHighResolutionRadius
DtRwOffsetVector	mySensorOffset
DtRwInt	myRangeId
DtRwInt	mySensorTickTime
DtRwInt	myTickOverrunStrategy
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myTickPeriodUsesRealTime
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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
	DtObjectSensorDescriptor ()

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

DtObjectSensorDescriptor::DtObjectSensorDescriptor ( )

private

default constructor; not implemented

DtObjectSensorDescriptor::DtObjectSensorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtObjectSensorDescriptor::DtObjectSensorDescriptor	(	const DtObjectSensorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtObjectSensorDescriptor::~DtObjectSensorDescriptor ( )

virtual

destructor

Member Function Documentation

DtObjectSensorDescriptor& DtObjectSensorDescriptor::operator=

(

const DtObjectSensorDescriptor &

orig

)

assignment

virtual DtString DtObjectSensorDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtObjectSensorDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSignatureObjectSensorDescriptor, DtRadarObjectSensorDescriptor, DtSearchRescueSensorDescriptor, DtActiveSonarSensorDescriptor, DtEngineeringObjectSensorDescriptor, DtNbcSensorDescriptor, and DtPassiveSonarSensorDescriptor.

virtual bool DtObjectSensorDescriptor::detectOnlyHostileForces ( ) const

virtual

See myDetectOnlyHostileForces.

virtual void DtObjectSensorDescriptor::setDetectOnlyHostileForces ( bool  value )

virtual

See myDetectOnlyHostileForces.

virtual bool DtObjectSensorDescriptor::detectOwnForce ( ) const

virtual

See Also

#myDectedOwnForce

virtual void DtObjectSensorDescriptor::setDetectOwnForce ( bool  v )

virtual

See Also

#myDectedOwnForce

virtual void DtObjectSensorDescriptor::setDetectionTypes ( const DtRwObjectTypeList &  objectTypes )

virtual

Accessor/mutator for myDetectionTypes.

virtual DtRwObjectTypeList& DtObjectSensorDescriptor::detectionTypes ( )

virtual

Accessor/mutator for myDetectionTypes.

virtual const DtRwObjectTypeList& DtObjectSensorDescriptor::detectionTypes ( ) const

virtual

Accessor/mutator for myDetectionTypes.

virtual void DtObjectSensorDescriptor::setDetectDestroyedObjects ( bool  value )

virtual

Accessor/mutator for myDetectDestroyedObjects.

virtual bool DtObjectSensorDescriptor::detectDestroyedObjects ( ) const

virtual

Accessor/mutator for myDetectDestroyedObjects.

virtual DtReal DtObjectSensorDescriptor::detectionPeriod ( ) const

virtual

Accessor/mutator for myDetectionPeriod.

Reimplemented in DtActiveSonarSensorDescriptor.

virtual void DtObjectSensorDescriptor::setDetectionPeriod ( DtReal  detectionPeriod )

virtual

Accessor/mutator for myDetectionPeriod.

Reimplemented in DtActiveSonarSensorDescriptor.

virtual DtReal DtObjectSensorDescriptor::detectionPeriodVariance ( ) const

virtual

Accessor/mutator for myDetectionPeriodVariance.

virtual void DtObjectSensorDescriptor::setDetectionPeriodVariance ( DtReal  detectionPeriodVariance )

virtual

Accessor/mutator for myDetectionPeriodVariance.

virtual void DtObjectSensorDescriptor::setAddSensorRangeRing ( bool  value )

virtual

Accessor/mutator for myAddSensorRangeRing.

virtual bool DtObjectSensorDescriptor::addSensorRangeRing ( ) const

virtual

Accessor/mutator for myAddSensorRangeRing.

virtual void DtObjectSensorDescriptor::setWindDegradesSensorPerformanceWhenAbove ( double  )

virtual

Accessor/mutator for myWindDegradesSensorPerformanceWhenAbove.

virtual double DtObjectSensorDescriptor::windDegradesSensorPerformanceWhenAbove ( ) const

virtual

Accessor/mutator for myWindDegradesSensorPerformanceWhenAbove.

virtual void DtObjectSensorDescriptor::setWindDegradesSensorPerformanceUntil ( double  )

virtual

Accessor/mutator for myWindDegradesSensorPerformanceUntil.

virtual double DtObjectSensorDescriptor::windDegradesSensorPerformanceUntil ( ) const

virtual

Accessor/mutator for myWindDegradesSensorPerformanceUntil.

virtual void DtObjectSensorDescriptor::setWindDegradesSensorPerformanceBy ( double  )

virtual

Accessor/mutator for myWindDegradesSensorPerformanceBy.

virtual double DtObjectSensorDescriptor::windDegradesSensorPerformanceBy ( ) const

virtual

Accessor/mutator for myWindDegradesSensorPerformanceBy.

virtual void DtObjectSensorDescriptor::setPrecipitationDegradesSensorPerformanceBy ( double  )

virtual

Accessor/mutator for #myPreciptitationDegradesSensorPerformanceBy.

virtual double DtObjectSensorDescriptor::precipitationDegradesSensorPerformanceBy ( ) const

virtual

Accessor/mutator for #myPreciptitationDegradesSensorPerformanceBy.

virtual void DtObjectSensorDescriptor::setSuppressionDegradesSensorPerformanceBy ( double  )

virtual

Accessor/mutator for mySuppressionDegradesSensorPerformanceBy.

virtual double DtObjectSensorDescriptor::suppressionDegradesSensorPerformanceBy ( ) const

virtual

The factor by which sensor sensitivity is decreased when the entity is suppressed. A value from 0 to 1.0. E.g. if the factor is 0.7, then sensitivity is multiplied by 0.3 when the entity is suppressed.

virtual void DtObjectSensorDescriptor::setZoomEnhancesSensitivity ( bool  v )

virtual

See Also

myZoomEnhancesSensitivity

virtual bool DtObjectSensorDescriptor::zoomEnhancesSensitivity ( ) const

virtual

See Also

myZoomEnhancesSensitivity

virtual DtRwSpatialFilterContainer* DtObjectSensorDescriptor::sensorGeometry ( )

virtual

Accessor for mySensorGeometry.

virtual const DtRwSpatialFilterContainer* DtObjectSensorDescriptor::sensorGeometry ( ) const

virtual

Accessor for mySensorGeometry.

virtual bool DtObjectSensorDescriptor::canShowRadarCoverage ( ) const

virtual

Accessor for myCanShowRadarCoverage.

virtual void DtObjectSensorDescriptor::setCanShowRadarCoverage ( bool  )

virtual

Accessor for myCanShowRadarCoverage.

virtual double DtObjectSensorDescriptor::radarCoverageAzimuthSamplingRate ( ) const

virtual

Accessor for myRadarCoverageAzimuthSamplingRate.

virtual void DtObjectSensorDescriptor::setRadarCoverageAzimuthSamplingRate ( double  )

virtual

Accessor for myRadarCoverageAzimuthSamplingRate.

virtual double DtObjectSensorDescriptor::radarCoverageElevationSamplingRate ( ) const

virtual

Accessor for myRadarCoverageElevationSamplingRate.

virtual void DtObjectSensorDescriptor::setRadarCoverageElevationSamplingRate ( double  )

virtual

Accessor for myRadarCoverageElevationSamplingRate.

virtual double DtObjectSensorDescriptor::radarCoveragePostSpacing ( ) const

virtual

Accessor for myRadarCoveragePostSpacing.

virtual void DtObjectSensorDescriptor::setRadarCoveragePostSpacing ( double  )

virtual

Accessor for myRadarCoveragePostSpacing.

virtual double DtObjectSensorDescriptor::radarCoverageMovementDelta ( ) const

virtual

Accessor for myRadarCoverageMovementDelta.

virtual void DtObjectSensorDescriptor::setRadarCoverageMovementDelta ( double  )

virtual

Accessor for myRadarCoverageMovementDelta.

virtual double DtObjectSensorDescriptor::radarCoverageOrientationDelta ( ) const

virtual

Accessor for myRadarCoverageOrientationDelta.

virtual void DtObjectSensorDescriptor::setRadarCoverageOrientationDelta ( double  )

virtual

Accessor for myRadarCoverageOrientationDelta.

virtual double DtObjectSensorDescriptor::radarCoverageWaitTime ( ) const

virtual

Accessor for myRadarCoverageWaitTime.

virtual void DtObjectSensorDescriptor::setRadarCoverageWaitTime ( double  )

virtual

Accessor for myRadarCoverageWaitTime.

virtual double DtObjectSensorDescriptor::radarCoverageHighResolutionRadius ( ) const

virtual

Accessor for myRadarCoverageHighResolutionRadius.

virtual void DtObjectSensorDescriptor::setRadarCoverageHighResolutionRadius ( double  radius )

virtual

Accessor for myRadarCoverageHighResolutionRadius.

virtual const DtVector& DtObjectSensorDescriptor::sensorOffset ( ) const

virtual

Accessor/mutator for mySensorOffset.

virtual void DtObjectSensorDescriptor::setSensorOffset ( const DtVector &  sensorOffset )

virtual

Accessor/mutator for mySensorOffset.

virtual int DtObjectSensorDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtObjectSensorDescriptor::setRangeId ( int  rangeId )

virtual

Accessor/mutator for myRangeId.

virtual bool DtObjectSensorDescriptor::rangeIdIsSpecified ( ) const

virtual

Accessor/mutator for myRangeId.

virtual int DtObjectSensorDescriptor::sensorTickTime ( ) const

virtual

See Also

mySensorTickTime

virtual void DtObjectSensorDescriptor::setSensorTickTime ( int  ms )

virtual

See Also

mySensorTickTime

virtual int DtObjectSensorDescriptor::tickOverrunStrategy ( ) const

virtual

See Also

myTickOverrunStrategy

virtual void DtObjectSensorDescriptor::setTickOverrunStrategy ( int  s )

virtual

See Also

myTickOverrunStrategy

virtual DtComponentDescriptor* DtObjectSensorDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSignatureObjectSensorDescriptor, DtSearchRescueSensorDescriptor, DtRadarObjectSensorDescriptor, DtActiveSonarSensorDescriptor, DtEngineeringObjectSensorDescriptor, DtNbcSensorDescriptor, and DtPassiveSonarSensorDescriptor.

static DtComponentDescriptor* DtObjectSensorDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

virtual void DtObjectSensorDescriptor::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwBoolean DtObjectSensorDescriptor::myDetectOnlyHostileForces

protected

Parameter Name: detect-only-hostile-forces
Parameter Description: If true, this sensor will detect only entities that are of a force type hostile to the entity this sensor is on. This effects only the detection-types listed in this descriptor. If other force types are specified in the input port, those will be detected as well.
When false, all force types are detected. Parameter Default Value: true
.

DtRwBoolean DtObjectSensorDescriptor::myDetectOwnForce

protected

Parameter Name: detect-own-force
Parameter Description: This sensor will only detect objects of the same force as the host entity if this is set to true. This takes precedence over myDectedOnlyHostileForces. If the own-force is specified on the input port, then entities of own-force will be detected, even if this is set to false.
Parameter Default Value: False.

DtRwObjectTypeList DtObjectSensorDescriptor::myDetectionTypes

protected

Parameter Name: detection-types
Parameter Description: Types of objects to detect.
Parameter Default Value:
.

DtRwBoolean DtObjectSensorDescriptor::myDetectDestroyedObjects

protected

Parameter Name: detect-destroyed-objects
Parameter Description: Flag indicating whether or not to detected destroyed objects.
Parameter Default Value: false
.

DtRwReal DtObjectSensorDescriptor::myDetectionPeriod

protected

Parameter Name: detection-period
Parameter Description: The time between checks for new targets (or the removal of old targets). If a target has a 1 in 10 chance of being detected in the detection period, and the detection period is 1 second, then the target can be expected to be detected within 10 seconds, on average.
Parameter Default Value: 1.
Parameter Units: seconds.

DtRwReal DtObjectSensorDescriptor::myDetectionPeriodVariance

protected

Parameter Name: detection-period-variance
Parameter Description: Magnitude of random variance added to detection period in order to spread checks out over different ticks. Parameter Default Value: 0
Parameter Units: seconds.

DtRwBoolean DtObjectSensorDescriptor::myAddSensorRangeRing

protected

Parameter Name: add-sensor-range-ring
Parameter Description: Flag indicating whether or not to add a published sensor range ring named after the sensor domain.
Parameter Default Value: true
.

DtRwReal DtObjectSensorDescriptor::myWindDegradesSensorPerformanceWhenAbove

protected

Parameter Name: wind-degrades-sensor-performance-when-above
Parameter Description: Wind speed (in kilometers per hour) that, when reached, will start degrading sensor performance up to the maximum specified in the wind-degrades-by value.
Parameter Default Value: 0
.

DtRwReal DtObjectSensorDescriptor::myWindDegradesSensorPerformanceUntil

protected

Parameter Name: wind-degrades-sensor-performance-until
Parameter Description: Wind speed (in kilometers per hour) that is the upper bound of degradation. Between the upper and lower bound a percentage of the degradation factor will be used. Above that the maximum value is always used.
wind-degrades-by value.
Parameter Default Value: 0
.

DtRwReal DtObjectSensorDescriptor::myWindDegradesSensorPerformanceBy

protected

Parameter Name: wind-degrades-sensor-performance-by
Parameter Description: The maximum degradation factor for wind.
Parameter Default Value: 0
.

DtRwReal DtObjectSensorDescriptor::myPrecipitationDegradesSensorPerformanceBy

protected

Parameter Name: precipitation-degrades-sensor-performance-by
Parameter Description: The maximum degradation factor for precipitation (snow or rain). This parameter is not generally used for visual sensors as precipitation degrades the target signature and this is accounted for in the visual signature propagator.
Parameter Default Value: 0
.

DtRwReal DtObjectSensorDescriptor::mySuppressionDegradesSensorPerformanceBy

protected

Parameter Name: suppression-degrades-sensor-performance-by
Parameter Description: The maximum degradation factor for suppression. A value between 0 and 1.0. 1.0 means the sensor is completely ineffective when the entity is suppressed.
Parameter Default Value: 0
.

DtRwBoolean DtObjectSensorDescriptor::myZoomEnhancesSensitivity

protected

Parameter Name: zoom-enhances-sensitivity
Parameter Description: Indicates whether or not the zoom level of the sensor (if applicable) enhances the sensitivity value of the sensor. If true, the sensitivity is multiplied by the current zoom level.
Parameter Default Value: False
.

DtRwSpatialFilterContainer DtObjectSensorDescriptor::mySensorGeometry

protected

Parameter Name: sensor-geometry
Parameter Description: Geometry of the sensor coverage, such as range and/or a sensor frustum. Spatial filters can be combined with logical and/or/not operators as well.
Example 1: Every entity within 4000 meters of this sensor.
(in-range
(range 4000.000000)
)
Example 2: Every entity within 4000 meters of this sensor, and within the defined frustum of the look-direction of the sensor.
(and
(in-range
(range 4000.000000)
)
(in-frustum
(az-max 1.0472)
(az-min -1.0472)
(el-max 1.5708)
(el-min -1.5708)
)
)
Custom geometry filters can be created though the toolkit.
See documentation for DtRwSpatialFilter for more information.
Parameter Default Value:
.

DtRwBoolean DtObjectSensorDescriptor::myCanShowRadarCoverage

protected

Parameter Name: can-show-radar-coverage
Parameter Description: Flag indicating whether or not this object can process a radar coverage displau request on on the VR-Forces GUI right click menu.
Parameter Default Value: False.

DtRwReal DtObjectSensorDescriptor::myRadarCoverageAzimuthSamplingRate

protected

Parameter Name: radar-coverage-azimuth-sampling-rate
Parameter Description: The rate along the azimuth to test a new radar coverage sample point, in radians. The default is 1 degree, so, for a circle, this means 360 sample points along from the center along the radius of the circle.
Parameter Default Value: 1 degree (in radians)

DtRwReal DtObjectSensorDescriptor::myRadarCoverageElevationSamplingRate

protected

Parameter Name: radar-coverage-elevation-sampling-rate
Parameter Description: The rate along the elevation (in a 3D radar coverage calculation( to test a new radar coverage sample point, in radians. The default is 1 degree, so, for the default elevation check of a sweep from the current resting point to 90 degrees, this will be 90 sample point along the radius of the dome.
Parameter Default Value: 1 degree (in radians)

DtRwReal DtObjectSensorDescriptor::myRadarCoveragePostSpacing

protected

Parameter Name: radar-coverage-post-spacing
Parameter Description: For 2D radar coverage fans, the distance along the spoke to move and do an altitude check for line of sight, in meters Parameter Default Value: 1000.

DtRwReal DtObjectSensorDescriptor::myRadarCoverageMovementDelta

protected

Parameter Name: radar-coverage-movement-delta
Parameter Description: How far a simulation object has to move before triggering a recalculation of the radar coverage fan, waiting the appropriate myRadarCoverageWaitTime Parameter Default Value: 1 meter.

DtRwReal DtObjectSensorDescriptor::myRadarCoverageOrientationDelta

protected

Parameter Name: radar-coverage-orientation-delta
Parameter Description: How much the orientation (azimuth or pitch) of a simulation object can change before triggering a recalculation of the radar coverage fan, waiting the appropriate myRadarCoverageWaitTime Parameter Default Value: 1 degree (in radians)

DtRwReal DtObjectSensorDescriptor::myRadarCoverageWaitTime

protected

Parameter Name: radar-coverage-wait-time
Parameter Description: When something about the simulation object changes, or, on first request, the amount of time to wait since the last change before triggering a recalculation of the radar coverage fan Parameter Default Value: 2 seconds.

DtRwReal DtObjectSensorDescriptor::myRadarCoverageHighResolutionRadius

protected

Parameter Name: radar-coverage-high-resolution-radius
Parameter Description: Radius around entity to do high resolution terrain checks. The portion of terrain checks done inside this radius will be done against high resolution data, the portion outside will be done against low resolution data. Parameter Default: 1000 meters.

DtRwOffsetVector DtObjectSensorDescriptor::mySensorOffset

protected

Parameter Name: sensor-offset
Parameter Description: Vector added to the position of the entity with this sensor to determine the start point for intervisibility calculations.
Parameter Default Value: (0. 0. 0.)
.

DtRwInt DtObjectSensorDescriptor::myRangeId

protected

Parameter Name: range-id
Parameter Description: The identifying value for the range ring. Can be converted to a string based on configured enumeration values.
Parameter Default Value: 0
.

DtRwInt DtObjectSensorDescriptor::mySensorTickTime

protected

Parameter Name: sensor-tick-time
Parameter Description: Maximum time in ms that the sensor will tick each frame. Parameter Default Value: 10
.

DtRwInt DtObjectSensorDescriptor::myTickOverrunStrategy

protected

Parameter Name: tick-overrun-strategy
Parameter Description: Behavior of the sensor if it is unable to complete its sensor computations in the tick time provided (spread over the frames between detection periods). 0 - Compute all detections before in final frame. (will exceed sensor-tick-time for these frames) 1 - Restart detections. (Some potential detections will not be calculated) 2 - Delay next detection cycle. (Detection cycle will be slower than specified, but all potential detections will be calculated) Parameter Default Value: 0
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/objectSensorDescriptor.h