VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions
DtStandardSignaturePropagator Class Reference

Signature propagator useful in any standard sensor domain. More...

Inheritance diagram for DtStandardSignaturePropagator:
Inheritance graph
[legend]

Public Member Functions

 DtStandardSignaturePropagator (const DtSignaturePropagatorDescriptor *desc, DtPhysicalWorld *physicalWorld)
 default constructor
virtual ~DtStandardSignaturePropagator ()
 destructor
virtual void init ()
 Assigns myStandardPropagatorDescriptor by casting the result of descriptor().
virtual double calculateApparentSignature (double absoluteSignature, const DtSignaturePropagatorArgs &args) const
 Calculates the apparent signature from the provided absolute signature.
- Public Member Functions inherited from DtSignaturePropagator
 DtSignaturePropagator (const DtSignaturePropagatorDescriptor *descriptor, DtPhysicalWorld *physicalWorld)
virtual ~DtSignaturePropagator ()
 destructor
virtual const
DtSignaturePropagatorDescriptor
descriptor () const
virtual const DtPhysicalWorldphysicalWorld () const

Static Public Member Functions

static DtSignaturePropagatorcreate (const DtSignaturePropagatorDescriptor *desc, DtPhysicalWorld *physicalWorld)
 Creates a new instance of this class, calls init() on it, and returns it.
- Static Public Member Functions inherited from DtSignaturePropagator
static void setFactory (DtSignaturePropagatorFactory *factory)
 Sets the static factory member.
static DtSignaturePropagatorcreateSignaturePropagator (const DtString &type, const DtSignaturePropagatorDescriptor *desc, DtPhysicalWorld *physicalWorld)
 Uses the static factory assigned in setFactory to create the requested signature propagator type.

Protected Attributes

const
DtStandardPropagatorDescriptor
myStandardPropagatorDescriptor
- Protected Attributes inherited from DtSignaturePropagator
const
DtSignaturePropagatorDescriptor
myDescriptor
DtPhysicalWorldmyPhysicalWorld

Private Member Functions

 DtStandardSignaturePropagator (const DtStandardSignaturePropagator &orig)
 copy constructor - not implemented
DtStandardSignaturePropagatoroperator= (const DtStandardSignaturePropagator &orig)
 assignment operator - not implemented

Additional Inherited Members

- Static Protected Attributes inherited from DtSignaturePropagator
static
DtSignaturePropagatorFactory
theFactory

Detailed Description

Signature propagator useful in any standard sensor domain.

This propagator returns an apparent signature based on the absolute signature * 1000 / distance traveled in meters. This means that an apparent signature of 1.0 is observed when the distance from the target in km equals the target's absolute signature. If check-line-of-sight is set to True (the default), the DtPhysicalWorld::checkLineOfSight() call is used to determine if anything is between the observer and observee, and if so, returns a signature of 0.0. This propagator requires a DtStandardPropagatorDescriptor descriptor type.

Constructor & Destructor Documentation

DtStandardSignaturePropagator::DtStandardSignaturePropagator ( const DtSignaturePropagatorDescriptor desc,
DtPhysicalWorld physicalWorld 
)

default constructor

virtual DtStandardSignaturePropagator::~DtStandardSignaturePropagator ( )
virtual

destructor

DtStandardSignaturePropagator::DtStandardSignaturePropagator ( const DtStandardSignaturePropagator orig)
private

copy constructor - not implemented

Member Function Documentation

virtual void DtStandardSignaturePropagator::init ( )
virtual

Assigns myStandardPropagatorDescriptor by casting the result of descriptor().

Reimplemented from DtSignaturePropagator.

Reimplemented in DtVisualSignaturePropagator, DtActiveSonarSignaturePropagator, DtPassiveSonarSignaturePropagator, and MySignaturePropagator.

virtual double DtStandardSignaturePropagator::calculateApparentSignature ( double  absoluteSignature,
const DtSignaturePropagatorArgs args 
) const
virtual

Calculates the apparent signature from the provided absolute signature.

Deriving classes must override this function to provide the implementation for apparent signature they desire.

Implements DtSignaturePropagator.

Reimplemented in DtVisualSignaturePropagator, MySignaturePropagator, DtActiveSonarSignaturePropagator, and DtPassiveSonarSignaturePropagator.

static DtSignaturePropagator* DtStandardSignaturePropagator::create ( const DtSignaturePropagatorDescriptor desc,
DtPhysicalWorld physicalWorld 
)
static

Creates a new instance of this class, calls init() on it, and returns it.

Reimplemented in DtVisualSignaturePropagator, MySignaturePropagator, DtActiveSonarSignaturePropagator, and DtPassiveSonarSignaturePropagator.

DtStandardSignaturePropagator& DtStandardSignaturePropagator::operator= ( const DtStandardSignaturePropagator orig)
private

assignment operator - not implemented

Member Data Documentation

const DtStandardPropagatorDescriptor* DtStandardSignaturePropagator::myStandardPropagatorDescriptor
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)