DtPassiveSonarSensorDescriptor Class Reference

DtPassiveSonarSensorDescriptor; descriptor for the DtPassiveSonarSensor component. More...

Inheritance diagram for DtPassiveSonarSensorDescriptor:

Public Member Functions
	DtPassiveSonarSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtPassiveSonarSensorDescriptor (const DtPassiveSonarSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtPassiveSonarSensorDescriptor &	operator= (const DtPassiveSonarSensorDescriptor &orig)
	assignment
virtual	~DtPassiveSonarSensorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxEffectiveSpeed () const
	Accessor/mutator for myMaxEffectiveSpeed.
virtual void	setMaxEffectiveSpeed (DtReal detectionPeriod)
virtual bool	sonarDipCapable () const
	Accessor/mutator for mySonarDipCapable.
virtual void	setSonarDipCapable (bool v)
virtual bool	usableWhileRetracted () const
	Accessor/mutator for myUsableWhileRetracted.
virtual void	setUsableWhileRetracted (bool v)
Public Member Functions inherited from DtSignatureObjectSensorDescriptor
	DtSignatureObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSignatureObjectSensorDescriptor (const DtSignatureObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtSignatureObjectSensorDescriptor &	operator= (const DtSignatureObjectSensorDescriptor &orig)
	assignment
virtual	~DtSignatureObjectSensorDescriptor ()
	destructor
virtual DtString	sensorDomain () const
	Accessor/mutator for mySensorDomain.
virtual void	setSensorDomain (const DtString &domain)
virtual const double	sensorError () const
	Accessor/mutator for mySensorPositionalError.
virtual void	setSensorError (const double sensorError)
virtual const double	sensorSensitivity () const
	Accessor/mutator for mySensorSensitivity.
virtual void	setSensorSensitivity (const double sensorSensitivity)
virtual const DtPrbStepFunction &	detectionProbabilityTable () const
	Accessor/mutator for myDetectionProbabilityTable.
virtual void	setDetectionProbabilityTable (const DtPrbStepFunction &params)
virtual const DtRwDetectionLevelContainer &	sensorDetectLevelDeterminatorParameters () const
	Accessor/mutator for myDetectLevelDeterminatorContainer.
virtual void	setSensorDetectLevelDeterminatorParameters (const DtRwDetectionLevelContainer &params)
virtual void	setPublishSensorFieldOfView (bool value)
	Accessor/mutator for myPublishSensorFieldOfView.
virtual bool	publishSensorFieldOfView () const
virtual const DtSensorFieldOfViewEntry &	sensorFieldOfView () const
	Accessor/mutator for mySensorFieldOfView.
virtual DtSensorFieldOfViewEntry &	sensorFieldOfView ()
Public Member Functions inherited from DtObjectSensorDescriptor
	DtObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtObjectSensorDescriptor (const DtObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtObjectSensorDescriptor &	operator= (const DtObjectSensorDescriptor &orig)
	assignment
virtual	~DtObjectSensorDescriptor ()
	destructor
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual bool	detectOnlyHostileForces () const
	See myDetectOnlyHostileForces.
virtual void	setDetectOnlyHostileForces (bool value)
virtual bool	detectOwnForce () const
virtual void	setDetectOwnForce (bool v)
virtual void	setDetectionTypes (const DtRwObjectTypeList &objectTypes)
	Accessor/mutator for myDetectionTypes.
virtual DtRwObjectTypeList &	detectionTypes ()
virtual const DtRwObjectTypeList &	detectionTypes () const
virtual void	setDetectDestroyedObjects (bool value)
	Accessor/mutator for myDetectDestroyedObjects.
virtual bool	detectDestroyedObjects () const
virtual DtReal	detectionPeriod () const
	Accessor/mutator for myDetectionPeriod.
virtual void	setDetectionPeriod (DtReal detectionPeriod)
virtual DtReal	detectionPeriodVariance () const
	Accessor/mutator for myDetectionPeriodVariance.
virtual void	setDetectionPeriodVariance (DtReal detectionPeriodVariance)
virtual void	setAddSensorRangeRing (bool value)
	Accessor/mutator for myAddSensorRangeRing.
virtual bool	addSensorRangeRing () const
virtual void	setWindDegradesSensorPerformanceWhenAbove (double)
	Accessor/mutator for myWindDegradesSensorPerformanceWhenAbove.
virtual double	windDegradesSensorPerformanceWhenAbove () const
virtual void	setWindDegradesSensorPerformanceUntil (double)
	Accessor/mutator for myWindDegradesSensorPerformanceUntil.
virtual double	windDegradesSensorPerformanceUntil () const
virtual void	setWindDegradesSensorPerformanceBy (double)
	Accessor/mutator for myWindDegradesSensorPerformanceBy.
virtual double	windDegradesSensorPerformanceBy () const
virtual void	setPrecipitationDegradesSensorPerformanceBy (double)
	Accessor/mutator for #myPreciptitationDegradesSensorPerformanceBy.
virtual double	precipitationDegradesSensorPerformanceBy () const
virtual void	setSuppressionDegradesSensorPerformanceBy (double)
	Accessor/mutator for mySuppressionDegradesSensorPerformanceBy.
virtual double	suppressionDegradesSensorPerformanceBy () const
	The factor by which sensor sensitivity is decreased when the entity is suppressed.
virtual void	setZoomEnhancesSensitivity (bool v)
virtual bool	zoomEnhancesSensitivity () const
virtual DtRwSpatialFilterContainer *	sensorGeometry ()
	Accessor for mySensorGeometry.
virtual const DtRwSpatialFilterContainer *	sensorGeometry () const
virtual bool	canShowRadarCoverage () const
	Accessor for myCanShowRadarCoverage.
virtual void	setCanShowRadarCoverage (bool)
virtual double	radarCoverageAzimuthSamplingRate () const
	Accessor for myRadarCoverageAzimuthSamplingRate.
virtual void	setRadarCoverageAzimuthSamplingRate (double)
virtual double	radarCoverageElevationSamplingRate () const
	Accessor for myRadarCoverageElevationSamplingRate.
virtual void	setRadarCoverageElevationSamplingRate (double)
virtual double	radarCoveragePostSpacing () const
	Accessor for myRadarCoveragePostSpacing.
virtual void	setRadarCoveragePostSpacing (double)
virtual double	radarCoverageMovementDelta () const
	Accessor for myRadarCoverageMovementDelta.
virtual void	setRadarCoverageMovementDelta (double)
virtual double	radarCoverageOrientationDelta () const
	Accessor for myRadarCoverageOrientationDelta.
virtual void	setRadarCoverageOrientationDelta (double)
virtual double	radarCoverageWaitTime () const
	Accessor for myRadarCoverageWaitTime.
virtual void	setRadarCoverageWaitTime (double)
virtual double	radarCoverageHighResolutionRadius () const
	Accessor for myRadarCoverageHighResolutionRadius.
virtual void	setRadarCoverageHighResolutionRadius (double radius)
virtual const DtVector &	sensorOffset () const
	Accessor/mutator for mySensorOffset.
virtual void	setSensorOffset (const DtVector &sensorOffset)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
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)
	Type of DtSimComponent this descriptor is associated with.
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)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
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)
	Should the component be created or not.
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object.
virtual bool	createOnRemoteObject () 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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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 void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxEffectiveSpeed
	Parameter Name: max-effective-speed Parameter Description: The maximum speed at which this sensor will function.
DtRwBoolean	mySonarDipCapable
	Parameter Name: sonar-dip-capable Parameter Description: Flag indicating whether or not this component is capable of performing sensor dips.
DtRwBoolean	myUsableWhileRetracted
	Parameter Name: usable-while-retracted Parameter Description: If a sensor is capable of performing sonar dips, this flag indicates whether the sonar is usable while it is retracted.
Protected Attributes inherited from DtSignatureObjectSensorDescriptor
DtRwString	mySensorDomain
	Parameter Name: sensor-domain Parameter Description: String identifying what domain this sensor operates in.
DtRwReal	mySensorPositionalError
	Parameter Name: sensor-positional-error Parameter Description: The error associated with determining the physical characteristics of a object ie position, velocity inherent to this kind of sensor.
DtRwReal	mySensorSensitivity
	Parameter Name: sensor-sensitivity Parameter Description: The sensitivity of the sensor.
DtPrbStepFunction	myDetectionProbabilityTable
	Parameter Name: detection-probability Parameter Description: This a table of detection probability by apparent signature of the target.
DtRwDetectionLevelContainer	myDetectLevelDeterminatorContainer
	Parameter Name: detection-level-determinator Parameter Description: This a list of the parameters used to define the sensor's detection level determinator which is responsible for determining the level of detection of the objects the sensor detects.
DtRwBoolean	myPublishSensorFieldOfView
	Parameter Name: publish-sensor-field-of-view Parameter Description: Flag indicating whether or not to publish a sensor field of view object.
DtSensorFieldOfViewEntry	mySensorFieldOfView
	Parameter Name: emitter-system Parameter Description: A DtSensorFieldOfViewEntry that manages the publishing of the sensor field of view.
Protected Attributes inherited from DtObjectSensorDescriptor
DtRwBoolean	myDetectOnlyHostileForces
	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.
DtRwBoolean	myDetectOwnForce
	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.
DtRwObjectTypeList	myDetectionTypes
	Parameter Name: detection-types Parameter Description: Types of objects to detect.
DtRwBoolean	myDetectDestroyedObjects
	Parameter Name: detect-destroyed-objects Parameter Description: Flag indicating whether or not to detected destroyed objects.
DtRwReal	myDetectionPeriod
	Parameter Name: detection-period Parameter Description: The time between checks for new targets (or the removal of old targets).
DtRwReal	myDetectionPeriodVariance
	Parameter Name: detection-period-variance Parameter Description: Magnitude of random variance added to detection period in order to spread checks out over different ticks.
DtRwBoolean	myAddSensorRangeRing
	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.
DtRwReal	myWindDegradesSensorPerformanceWhenAbove
	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.
DtRwReal	myWindDegradesSensorPerformanceUntil
	Parameter Name: wind-degrades-sensor-performance-until Parameter Description: Wind speed (in kilometers per hour) that is the upper bound of degradation.
DtRwReal	myWindDegradesSensorPerformanceBy
	Parameter Name: wind-degrades-sensor-performance-by Parameter Description: The maximum degradation factor for wind.
DtRwReal	myPrecipitationDegradesSensorPerformanceBy
	Parameter Name: precipitation-degrades-sensor-performance-by Parameter Description: The maximum degradation factor for precipitation (snow or rain).
DtRwReal	mySuppressionDegradesSensorPerformanceBy
	Parameter Name: suppression-degrades-sensor-performance-by Parameter Description: The maximum degradation factor for suppression.
DtRwBoolean	myZoomEnhancesSensitivity
	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.
DtRwSpatialFilterContainer	mySensorGeometry
	Parameter Name: sensor-geometry Parameter Description: Geometry of the sensor coverage, such as range and/or a sensor frustum.
DtRwBoolean	myCanShowRadarCoverage
	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.
DtRwReal	myRadarCoverageAzimuthSamplingRate
	Parameter Name: radar-coverage-azimuth-sampling-rate Parameter Description: The rate along the azimuth to test a new radar coverage sample point, in radians.
DtRwReal	myRadarCoverageElevationSamplingRate
	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.
DtRwReal	myRadarCoveragePostSpacing
	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	myRadarCoverageMovementDelta
	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	myRadarCoverageOrientationDelta
	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	myRadarCoverageWaitTime
	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	myRadarCoverageHighResolutionRadius
	Parameter Name: radar-coverage-high-resolution-radius Parameter Description: Radius around entity to do high resolution terrain checks.
DtRwOffsetVector	mySensorOffset
	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.
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component.
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not.
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations.
DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled.
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Private Member Functions
	DtPassiveSonarSensorDescriptor ()
	default constructor; 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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtPassiveSonarSensorDescriptor; descriptor for the DtPassiveSonarSensor component.

Constructor & Destructor Documentation

DtPassiveSonarSensorDescriptor::DtPassiveSonarSensorDescriptor ( )

private

default constructor; not implemented

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

constructor

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

copy constructor

virtual DtPassiveSonarSensorDescriptor::~DtPassiveSonarSensorDescriptor ( )

virtual

destructor

Member Function Documentation

DtPassiveSonarSensorDescriptor& DtPassiveSonarSensorDescriptor::operator=

(

const DtPassiveSonarSensorDescriptor &

orig

)

assignment

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

DtPassiveSonarSensorDescriptorType

Reimplemented from DtSignatureObjectSensorDescriptor.

Reimplemented in DtActiveSonarSensorDescriptor.

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

virtual

Reimplemented from DtSignatureObjectSensorDescriptor.

Reimplemented in DtActiveSonarSensorDescriptor.

static DtComponentDescriptor* DtPassiveSonarSensorDescriptor::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.

Reimplemented from DtSignatureObjectSensorDescriptor.

Reimplemented in DtActiveSonarSensorDescriptor.

virtual DtReal DtPassiveSonarSensorDescriptor::maxEffectiveSpeed ( ) const

virtual

Accessor/mutator for myMaxEffectiveSpeed.

virtual void DtPassiveSonarSensorDescriptor::setMaxEffectiveSpeed ( DtReal  detectionPeriod )

virtual

virtual bool DtPassiveSonarSensorDescriptor::sonarDipCapable ( ) const

virtual

Accessor/mutator for mySonarDipCapable.

virtual void DtPassiveSonarSensorDescriptor::setSonarDipCapable ( bool  v )

virtual

virtual bool DtPassiveSonarSensorDescriptor::usableWhileRetracted ( ) const

virtual

Accessor/mutator for myUsableWhileRetracted.

virtual void DtPassiveSonarSensorDescriptor::setUsableWhileRetracted ( bool  v )

virtual

Member Data Documentation

DtRwReal DtPassiveSonarSensorDescriptor::myMaxEffectiveSpeed

protected

Parameter Name: max-effective-speed
Parameter Description: The maximum speed at which this sensor will function.

Parameter Default Value: 10.
Parameter Units: meters-per-second

DtRwBoolean DtPassiveSonarSensorDescriptor::mySonarDipCapable

protected

Parameter Name: sonar-dip-capable
Parameter Description: Flag indicating whether or not this component is capable of performing sensor dips.

Parameter Default Value: False

DtRwBoolean DtPassiveSonarSensorDescriptor::myUsableWhileRetracted

protected

Parameter Name: usable-while-retracted
Parameter Description: If a sensor is capable of performing sonar dips, this flag indicates whether the sonar is usable while it is retracted.

If the sonar is not capable of sonar dips, this should be assumed to be true. Parameter Default Value: True

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/passiveSonarSensorDescriptor.h