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)
	Accessor/mutator for myMaxEffectiveSpeed.

virtual bool	sonarDipCapable () const
	Accessor/mutator for mySonarDipCapable.
virtual void	setSonarDipCapable (bool v)
	Accessor/mutator for mySonarDipCapable.

virtual bool	usableWhileRetracted () const
	Accessor/mutator for myUsableWhileRetracted.
virtual void	setUsableWhileRetracted (bool v)
	Accessor/mutator for myUsableWhileRetracted.
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)
	Accessor/mutator for mySensorDomain.
virtual const DtVector &	sensorOffset () const
	Accessor/mutator for mySensorOffset.
virtual void	setSensorOffset (const DtVector &sensorOffset)
	Accessor/mutator for mySensorOffset.
virtual const double	sensorError () const
	Accessor/mutator for mySensorPositionalError.
virtual void	setSensorError (const double sensorError)
	Accessor/mutator for mySensorPositionalError.
virtual const DtRwDetectionLevelContainer &	sensorDetectLevelDeterminatorParameters () const
	Accessor/mutator for myDetectLevelDeterminatorContainer.
virtual void	setSensorDetectLevelDeterminatorParameters (const DtRwDetectionLevelContainer &params)
	Accessor/mutator for myDetectLevelDeterminatorContainer.
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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual bool	detectOnlyHostileForces () const
	See myDetectOnlyHostileForces.
virtual void	setDetectOnlyHostileForces (bool value)
	See myDetectOnlyHostileForces.
virtual void	setDetectionTypes (const DtRwObjectTypeList &objectTypes)
	Accessor/mutator for myDetectionTypes.
virtual DtRwObjectTypeList &	detectionTypes ()
	Accessor/mutator for myDetectionTypes.
virtual const DtRwObjectTypeList &	detectionTypes () const
	Accessor/mutator for myDetectionTypes.
virtual void	setDetectDestroyedObjects (bool value)
	Accessor/mutator for myDetectDestroyedObjects.
virtual bool	detectDestroyedObjects () const
	Accessor/mutator for myDetectDestroyedObjects.
virtual DtRwSpatialFilterContainer *	sensorGeometry ()
	Accessor for mySensorGeometry.
virtual const DtRwSpatialFilterContainer *	sensorGeometry () const
	Accessor for mySensorGeometry.
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 (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
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 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
	Type of DtSimComponent this descriptor is associated with.
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
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
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 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.
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.
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.
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.
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.
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.
DtRwSpatialFilterContainer	mySensorGeometry
	Parameter Name: sensor-geometry Parameter Description: Geometry of the sensor coverage, such as range and/or a sensor frustum.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
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 assoicated with this component.
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
	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::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

Accessor/mutator for myMaxEffectiveSpeed.

virtual bool DtPassiveSonarSensorDescriptor::sonarDipCapable ( ) const

virtual

Accessor/mutator for mySonarDipCapable.

virtual void DtPassiveSonarSensorDescriptor::setSonarDipCapable ( bool v )

virtual

Accessor/mutator for mySonarDipCapable.

virtual bool DtPassiveSonarSensorDescriptor::usableWhileRetracted ( ) const

virtual

Accessor/mutator for myUsableWhileRetracted.

virtual void DtPassiveSonarSensorDescriptor::setUsableWhileRetracted ( bool v )

virtual

Accessor/mutator for myUsableWhileRetracted.

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation