DtSignaturePropagator Class Reference

Base class for all sensor signal propagators. More...

Inheritance diagram for DtSignaturePropagator:

List of all members.

Public Member Functions
	DtSignaturePropagator (const DtSignaturePropagatorDescriptor *descriptor, DtPhysicalWorld *physicalWorld)
virtual	~DtSignaturePropagator ()
	destructor
virtual void	init ()
	Virtual init called immediately after creation.
virtual double	calculateApparentSignature (double absoluteSignature, const DtSignaturePropagatorArgs &args) const =0
	Calculates the apparent signature from the provided absolute signature.
virtual const DtSignaturePropagatorDescriptor *	descriptor () const
virtual const DtPhysicalWorld *	physicalWorld () const
Static Public Member Functions
static void	setFactory (DtSignaturePropagatorFactory *factory)
	Sets the static factory member.
static DtSignaturePropagator *	createSignaturePropagator (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 DtSignaturePropagatorDescriptor *	myDescriptor
DtPhysicalWorld *	myPhysicalWorld
Static Protected Attributes
static DtSignaturePropagatorFactory *	theFactory
Private Member Functions
	DtSignaturePropagator ()
	Not Implemented.
	DtSignaturePropagator (const DtSignaturePropagator &orig)
	copy constructor - not implemented
DtSignaturePropagator &	operator= (const DtSignaturePropagator &orig)
	assignment operator - not implemented

---

Detailed Description

Base class for all sensor signal propagators.

Signal propagators model the propagation of an absolute sensor signature of an entity as it changes when it is views from some location within the environment. This new value is called the apparent signature, and is the result of this class.

Different sensor domains may have different signature propagation models. All signature propagation models are derived from this class and registered with the DtSignaturePropagatorFactory.

---

Constructor & Destructor Documentation

DtSignaturePropagator::DtSignaturePropagator

(

)

[private]

Not Implemented.

DtSignaturePropagator::DtSignaturePropagator

(

const DtSignaturePropagator &

orig

)

[private]

copy constructor - not implemented

DtSignaturePropagator::DtSignaturePropagator	(	const DtSignaturePropagatorDescriptor *	descriptor,
		DtPhysicalWorld *	physicalWorld
	)

virtual DtSignaturePropagator::~DtSignaturePropagator

(

)

[virtual]

destructor

---

Member Function Documentation

DtSignaturePropagator& DtSignaturePropagator::operator=

(

const DtSignaturePropagator &

orig

)

[private]

assignment operator - not implemented

virtual void DtSignaturePropagator::init

(

)

[virtual]

Virtual init called immediately after creation.

Reimplemented in DtVisualSignaturePropagator, and DtStandardSignaturePropagator.

virtual double DtSignaturePropagator::calculateApparentSignature	(	double	absoluteSignature,
		const DtSignaturePropagatorArgs &	args
	)		const [pure 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.

Implemented in DtVisualSignaturePropagator, and DtStandardSignaturePropagator.

virtual const DtSignaturePropagatorDescriptor* DtSignaturePropagator::descriptor

(

)

const [virtual]

Returns:

A pointer to the descriptor for this propagator.

virtual const DtPhysicalWorld* DtSignaturePropagator::physicalWorld

(

)

const [virtual]

Returns:

A pointer to the DtPhysicalWorld.

static void DtSignaturePropagator::setFactory

(

DtSignaturePropagatorFactory *

factory

)

[static]

Sets the static factory member.

static DtSignaturePropagator* DtSignaturePropagator::createSignaturePropagator	(	const DtString &	type,
		const DtSignaturePropagatorDescriptor *	desc,
		DtPhysicalWorld *	physicalWorld
	)		[static]

Uses the static factory assigned in setFactory to create the requested signature propagator type.

---

Member Data Documentation

DtSignaturePropagatorFactory* DtSignaturePropagator::theFactory [static, protected]

const DtSignaturePropagatorDescriptor* DtSignaturePropagator::myDescriptor [protected]

DtPhysicalWorld* DtSignaturePropagator::myPhysicalWorld [protected]

---

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

• include/vrfobjcore/signaturePropagator.h