DtSearchRescueSensorDescriptor; descriptor for the DtSearchRescueSensor component.

Instances of DtSearchRescueSensorDescriptor are used to specify the parameters for a DtSearchRescueSensor object.

Inheritance diagram for DtSearchRescueSensorDescriptor:

Public Member Functions
	DtSearchRescueSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtSearchRescueSensorDescriptor (const DtSearchRescueSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)

DtSearchRescueSensorDescriptor &	operator= (const DtSearchRescueSensorDescriptor &orig)

virtual	~DtSearchRescueSensorDescriptor ()

virtual DtString	type () const

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


virtual const unsigned int	trackingFrequency () const

virtual void	setTrackingFrequency (const unsigned int freq)

Public Member Functions inherited from DtSignatureObjectSensorDescriptor
	DtSignatureObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtSignatureObjectSensorDescriptor (const DtSignatureObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)

DtSignatureObjectSensorDescriptor &	operator= (const DtSignatureObjectSensorDescriptor &orig)

virtual	~DtSignatureObjectSensorDescriptor ()

virtual DtString	sensorDomain () const

virtual void	setSensorDomain (const DtString &domain)

virtual const double	sensorError () const

virtual void	setSensorError (const double sensorError)

virtual const double	sensorSensitivity () const

virtual void	setSensorSensitivity (const double sensorSensitivity)

virtual const DtPrbStepFunction &	detectionProbabilityTable () const

virtual void	setDetectionProbabilityTable (const DtPrbStepFunction &params)

virtual const DtRwDetectionLevelContainer &	sensorDetectLevelDeterminatorParameters () const

virtual void	setSensorDetectLevelDeterminatorParameters (const DtRwDetectionLevelContainer &params)

virtual void	setPublishSensorFieldOfView (bool value)

virtual bool	publishSensorFieldOfView () const

virtual const DtSensorFieldOfViewEntry &	sensorFieldOfView () const

virtual DtSensorFieldOfViewEntry &	sensorFieldOfView ()

virtual void	setAllowFirstDetectionWithoutTerrain (bool value)

virtual bool	allowFirstDetectionWithoutTerrain () const

Public Member Functions inherited from DtObjectSensorDescriptor
	DtObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

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

DtObjectSensorDescriptor &	operator= (const DtObjectSensorDescriptor &orig)

virtual	~DtObjectSensorDescriptor ()

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 DtSignatureObjectSensorDescriptor
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtObjectSensorDescriptor
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.
DtRwInt	myTrackingFrequency

Protected Attributes inherited from DtSignatureObjectSensorDescriptor
DtRwString	mySensorDomain

DtRwReal	mySensorPositionalError

DtRwReal	mySensorSensitivity

DtPrbStepFunction	myDetectionProbabilityTable

DtRwDetectionLevelContainer	myDetectLevelDeterminatorContainer

DtRwBoolean	myPublishSensorFieldOfView

DtSensorFieldOfViewEntry	mySensorFieldOfView

DtRwBoolean	myAllowFirstDetectionWithoutTerrain

Protected Attributes inherited from DtObjectSensorDescriptor
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
	DtSearchRescueSensorDescriptor ()

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

DtSearchRescueSensorDescriptor::DtSearchRescueSensorDescriptor ( )

private

default constructor; not implemented

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

constructor

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

copy constructor

virtual DtSearchRescueSensorDescriptor::~DtSearchRescueSensorDescriptor ( )

virtual

destructor

Member Function Documentation

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

assignment

virtual DtString DtSearchRescueSensorDescriptor::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: DtSearchRescueSensorDescriptorType

Reimplemented from DtSignatureObjectSensorDescriptor.

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

virtual

Reimplemented from DtSignatureObjectSensorDescriptor.

static DtComponentDescriptor* DtSearchRescueSensorDescriptor::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 const unsigned int DtSearchRescueSensorDescriptor::trackingFrequency ( ) const

virtual

Accessor/mutator for mySensorDomain.

virtual void DtSearchRescueSensorDescriptor::setTrackingFrequency ( const unsigned int freq )

virtual

Accessor/mutator for mySensorDomain.

Member Data Documentation

DtRwInt DtSearchRescueSensorDescriptor::myTrackingFrequency

protected

Parameter Name: tracking-frequency
Parameter Description: The frequency of transmitters to search for if any transmitters are out there. This is for search and rescue which uses 406MHz as the distress frequency
Parameter Default Value: 406MHz
.

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation