VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Private Member Functions
DtRadarObjectSensorDescriptor Class Reference

DtRadarObjectSensorDescriptor; descriptor for the DtRadarObjectSensor component. More...

Inheritance diagram for DtRadarObjectSensorDescriptor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRadarObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtRadarObjectSensorDescriptor (const DtRadarObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
DtRadarObjectSensorDescriptoroperator= (const DtRadarObjectSensorDescriptor &orig)
 assignment
virtual ~DtRadarObjectSensorDescriptor ()
 destructor
virtual DtString type () const
 Returns the type of component this descriptor describes.
virtual DtComponentDescriptorclone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal detectionPeriod () const
 Accessor/mutator for myDetectionPeriod.
virtual void setDetectionPeriod (DtReal detectionPeriod)
 Accessor/mutator for myDetectionPeriod.
virtual bool publishEmitterSystem () const
 Accessor/mutator for myPublishEmitterSystem.
virtual void setPublishEmitterSystem (bool v)
 Accessor/mutator for myPublishEmitterSystem.
virtual const
DtEmitterSystemEntry
emitterSystem () const
 Accessor/mutator for myEmitterSystem.
virtual DtEmitterSystemEntryemitterSystem ()
 Accessor/mutator for myEmitterSystem.

Static Public Member Functions

static DtComponentDescriptorcreator ()
 

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

DtRwReal myDetectionPeriod
 Parameter Name: detection-period
Parameter Description: The time between checks for new targets (or the removal of old targets).
DtRwBoolean myPublishEmitterSystem
 Parameter Name: publish-emitter-system
Parameter Description: Flag indicating whether or not to publish radar sensor as an emitter system.
DtEmitterSystemEntry myEmitterSystem
 Parameter Name: emitter-system
Parameter Description: A DtEmitterSystemEntry that manages the publishing of the emitter system.

Private Member Functions

 DtRadarObjectSensorDescriptor ()
 default constructor; not implemented

Detailed Description

DtRadarObjectSensorDescriptor; descriptor for the DtRadarObjectSensor component.

DtRadarObjectSensorDescriptor is a DtSignatureObjectSensorDescriptor that has additional information needed to publish a representative emitter system.


Constructor & Destructor Documentation

default constructor; not implemented

constructor

copy constructor

destructor


Member Function Documentation

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

assignment

virtual DtString DtRadarObjectSensorDescriptor::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:
DtRadarObjectSensorDescriptorType

Reimplemented from DtSignatureObjectSensorDescriptor.

virtual DtComponentDescriptor* DtRadarObjectSensorDescriptor::clone ( DtReaderWriterRegistry parentRegistry = 0) const [virtual]

Reimplemented from DtSignatureObjectSensorDescriptor.

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.

virtual DtReal DtRadarObjectSensorDescriptor::detectionPeriod ( ) const [virtual]

Accessor/mutator for myDetectionPeriod.

virtual void DtRadarObjectSensorDescriptor::setDetectionPeriod ( DtReal  detectionPeriod) [virtual]

Accessor/mutator for myDetectionPeriod.

Accessor/mutator for myPublishEmitterSystem.

Accessor/mutator for myPublishEmitterSystem.

Accessor/mutator for myEmitterSystem.

Accessor/mutator for myEmitterSystem.


Member Data Documentation

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

Parameter Name: publish-emitter-system
Parameter Description: Flag indicating whether or not to publish radar sensor as an emitter system.


Parameter Default Value: False

Parameter Name: emitter-system
Parameter Description: A DtEmitterSystemEntry that manages the publishing of the emitter system.


Parameter Default Value:


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)