DtSignatureModifierEvaluator Class Reference

The abstract base class for all evaluators of signature modifiers. More...

Inheritance diagram for DtSignatureModifierEvaluator:

List of all members.

Public Member Functions
	DtSignatureModifierEvaluator (const DtSignatureModifier &modifier, DtVrfObject *hostObject)
	default constructor
virtual	~DtSignatureModifierEvaluator ()
virtual bool	init ()
	Must be called immediately after creation.
virtual DtString	type () const =0
virtual double	modifySignature (double inputSignature) const =0
	This function implements the actual evaluation of the signature modifier.
Static Public Member Functions
static void	setFactory (DtSignatureModifierEvaluatorFactory *factory)
	Sets the static factory member.
static DtSignatureModifierEvaluator *	createSignatureModifierEvaluator (const DtString &type, const DtSignatureModifier &modifier, DtVrfObject *hostObject)
	Uses the static factory assigned in setFactory to create the requested sensor geometry type.
Protected Attributes
const DtSignatureModifier &	mySignatureModifier
DtVrfObject *	myHostObject
Static Protected Attributes
static DtSignatureModifierEvaluatorFactory *	theFactory
Private Member Functions
	DtSignatureModifierEvaluator ()
	Not implemented.
	DtSignatureModifierEvaluator (const DtSignatureModifierEvaluator &orig)
	Not implemented. Class not copyable.
DtSignatureModifierEvaluator &	operator= (const DtSignatureModifierEvaluator &orig)
	Not implemented. Class not copyable.

---

Detailed Description

The abstract base class for all evaluators of signature modifiers.

The evaluation of signature modifiers is split from the representation so that the representation is available without dependencies on internal VRF classes that are necessary for evaluation.

All signature modifier representations are subclasses of DtSignatureModifier. All signature modifier evaluators are subclasses of this class, and constructed with a reference to a DtSignatureModifier.

---

Constructor & Destructor Documentation

DtSignatureModifierEvaluator::DtSignatureModifierEvaluator

(

)

[private]

Not implemented.

DtSignatureModifierEvaluator::DtSignatureModifierEvaluator

(

const DtSignatureModifierEvaluator &

orig

)

[private]

Not implemented. Class not copyable.

DtSignatureModifierEvaluator::DtSignatureModifierEvaluator	(	const DtSignatureModifier &	modifier,
		DtVrfObject *	hostObject
	)

default constructor

virtual DtSignatureModifierEvaluator::~DtSignatureModifierEvaluator

(

)

[virtual]

---

Member Function Documentation

DtSignatureModifierEvaluator& DtSignatureModifierEvaluator::operator=

(

const DtSignatureModifierEvaluator &

orig

)

[private]

Not implemented. Class not copyable.

virtual bool DtSignatureModifierEvaluator::init

(

)

[virtual]

Must be called immediately after creation.

Returns:

True on successful initialization.

Reimplemented in DtSpeedLessSignatureModifierEvaluator, DtSpeedGreaterSignatureModifierEvaluator, DtFileSignatureModifierEvaluator, DtCoefficientsSignatureModifierEvaluator, DtEnvironmentalEffectsSignatureModifierEvaluator, and DtMultiplierSignatureModifierEvaluator.

virtual DtString DtSignatureModifierEvaluator::type

(

)

const [pure virtual]

Returns:

The string identifier for this SignatureModifierEvaluatory type. Types are specified in signatureModifierTypes.h and are shared with the DtSignatureModifier class hierarchy.

Implemented in DtSpeedLessSignatureModifierEvaluator, DtEnvironmentalEffectsSignatureModifierEvaluator, DtSpeedGreaterSignatureModifierEvaluator, and DtFileSignatureModifierEvaluator.

virtual double DtSignatureModifierEvaluator::modifySignature

(

double

inputSignature

)

const [pure virtual]

This function implements the actual evaluation of the signature modifier.

Takes the unmodified signature as input.

Returns:

The modified signature.

Implemented in DtFileSignatureModifierEvaluator, DtEnvironmentalEffectsSignatureModifierEvaluator, DtCoefficientsSignatureModifierEvaluator, and DtMultiplierSignatureModifierEvaluator.

static void DtSignatureModifierEvaluator::setFactory

(

DtSignatureModifierEvaluatorFactory *

factory

)

[static]

Sets the static factory member.

static DtSignatureModifierEvaluator* DtSignatureModifierEvaluator::createSignatureModifierEvaluator	(	const DtString &	type,
		const DtSignatureModifier &	modifier,
		DtVrfObject *	hostObject
	)		[static]

Uses the static factory assigned in setFactory to create the requested sensor geometry type.

---

Member Data Documentation

const DtSignatureModifier& DtSignatureModifierEvaluator::mySignatureModifier [protected]

DtVrfObject* DtSignatureModifierEvaluator::myHostObject [protected]

DtSignatureModifierEvaluatorFactory* DtSignatureModifierEvaluator::theFactory [static, protected]

---

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

• include/vrfobjcore/signatureModifierEvaluator.h