WsfInherentContrast Class Reference

An object that represents the inherent contrast of a platform. More...

#include <WsfInherentContrast.hpp>

Inheritance diagram for WsfInherentContrast:

Collaboration diagram for WsfInherentContrast:

Public Types
enum	{ cSIGNATURE_INDEX = 4 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfInherentContrast ()
WsfInherentContrast *	Clone () const override=0
virtual float	GetInherentContrast (WsfStringId aStateId, double aAzimuth, double aElevation)=0
Public Member Functions inherited from WsfSignature
	WsfSignature ()
	WsfSignature (const WsfSignature &aSrc)
WsfSignature &	operator= (const WsfSignature &)=delete
	~WsfSignature () override=default
virtual bool	InitializeType ()
virtual bool	Initialize (double aSimTime, WsfPlatform *aPlatformPtr)
virtual bool	IsA_ValidState (WsfStringId aId) const
virtual std::vector< WsfStringId >	GetStateNames () const
	get the list of all valid states belonging to the signature
bool	ProcessInput (UtInput &aInput) override
bool	RequiresPlatform () const
	indicates that a signature can be queried without a valid mPlatform
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Methods to support the actual interface on the platform.
These methods provide the interface from the sensor model to the signature. The user makes calls like WsfInherentContrast::GetValue(...).
static WsfStringId	GetInputType (WsfPlatform *aPlatformPtr)
static WsfStringId	GetState (WsfPlatform *aPlatformPtr)
static bool	SetState (WsfPlatform *aPlatformPtr, WsfStringId aState)
static float	GetScaleFactor (WsfPlatform *aPlatformPtr)
static bool	SetScaleFactor (WsfPlatform *aPlatformPtr, float aScaleFactor)
static float	GetValue (WsfPlatform *aPlatformPtr, double aAzimuth, double aElevation, bool aLogWarning=true)
static WsfInherentContrast *	GetObject (WsfPlatform *aPlatformPtr)
static void	RegisterScriptMethods (UtScriptTypes &aScriptTypes)
static void	RegisterInterface (WsfScenario &aScenario)
	Register the platform interface object on the prototype signature list in the specified scenario.

Additional Inherited Members
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Static Protected Member Functions inherited from WsfSignature
template<class SignatureState, WsfStringId SignatureState::* IdMember, typename Iterator>
static std::vector< WsfStringId >	GetStateNamesP (Iterator aBegin, Iterator aEnd)
Protected Attributes inherited from WsfSignature
WsfPlatform *	mPlatformPtr
double	mBaseTime
bool	mRequiresPlatform {false}

Detailed Description

An object that represents the inherent contrast of a platform.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
cSIGNATURE_INDEX	Index of signature within WsfSignatureList (must be unique).

Constructor & Destructor Documentation

WsfInherentContrast()

WsfInherentContrast::WsfInherentContrast

(

)

References WsfSignature::WsfSignature().

Referenced by Clone(), GetObject(), GetValue(), and WsfStandardInherentContrast::ObjectFactory().

Member Function Documentation

Clone()

WsfInherentContrast * WsfInherentContrast::Clone ( ) const

overridepure virtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

Implemented in WsfStandardInherentContrast.

References WsfInherentContrast().

GetInherentContrast()

virtual float WsfInherentContrast::GetInherentContrast ( WsfStringId aStateId, double aAzimuth, double aElevation )

pure virtual

Get the inherent contrast.

Parameters

aStateId	[input] The string ID representing the signature state to be used.
aAzimuth	[input] azimuth of the observer with respect to this platform (radians).
aElevation	[input] elevation of the observer with respect to this platform (radians).

Returns

The inherent contrast (non-dimensional)

Implemented in WsfStandardInherentContrast.

References GetInputType(), GetScaleFactor(), GetState(), GetValue(), SetScaleFactor(), and SetState().

Referenced by GetValue().

GetInputType()

WsfStringId WsfInherentContrast::GetInputType ( WsfPlatform * aPlatformPtr )

static

Get the input type of the signature.

Parameters

aPlatformPtr

[input] The pointer to the platform containing the signature.

Returns

The current signature state.

References cSIGNATURE_INDEX, WsfSignatureList::GetInputType(), and WsfPlatform::GetSignatureList().

Referenced by GetInherentContrast().

GetObject()

WsfInherentContrast * WsfInherentContrast::GetObject ( WsfPlatform * aPlatformPtr )

static

References RegisterInterface(), RegisterScriptMethods(), and WsfInherentContrast().

GetScaleFactor()

float WsfInherentContrast::GetScaleFactor ( WsfPlatform * aPlatformPtr )

static

Get the signature scale factor.

Parameters

aPlatformPtr

[input] The pointer to the platform containing the signature.

Returns

The signature scale factor.

References cSIGNATURE_INDEX, WsfSignatureList::GetScaleFactor(), and WsfPlatform::GetSignatureList().

Referenced by GetInherentContrast().

GetState()

WsfStringId WsfInherentContrast::GetState ( WsfPlatform * aPlatformPtr )

static

Get the current signature state.

Parameters

aPlatformPtr

[input] The pointer to the platform containing the signature.

Returns

The current signature state.

References cSIGNATURE_INDEX, WsfPlatform::GetSignatureList(), and WsfSignatureList::GetState().

Referenced by GetInherentContrast().

GetValue()

float WsfInherentContrast::GetValue ( WsfPlatform * aPlatformPtr, double aAzimuth, double aElevation, bool aLogWarning = true )

static

Get the signature value for a set of conditions.

Parameters

aPlatformPtr	[input] The platform from which the signature is to be retrieved.
aAzimuth	[input] azimuth of the observer with respect to this platform (radians).
aElevation	[input] elevation of the observer with respect to this platform (radians).
aLogWarning	[input] Tells function whether to log a warning if signature is not defined.

Returns

The inherent contrast.

References cSIGNATURE_INDEX, GetInherentContrast(), WsfObject::GetName(), WsfPlatform::GetSignatureList(), WsfObject::GetType(), and WsfInherentContrast().

Referenced by WsfOpticalSensor::OpticalMode::AttemptToDetect(), WsfEOIR_IRST_SensorMode::AttemptToDetectVisual(), and GetInherentContrast().

RegisterInterface()

void WsfInherentContrast::RegisterInterface ( WsfScenario & aScenario )

static

Register the platform interface object on the prototype signature list in the specified scenario.

References WsfSignatureList::AddInterface(), cSIGNATURE_INDEX, and WsfScenario::GetSignatureListPrototype().

Referenced by GetObject(), and WsfInherentContrastTypes::WsfInherentContrastTypes().

RegisterScriptMethods()

void WsfInherentContrast::RegisterScriptMethods ( UtScriptTypes & aScriptTypes )

static

Register the script methods associated with this class.

Note

The WsfPlatform script class must be defined before calling this method.

Referenced by WsfMilScriptExtensions::ExtendScriptClasses(), and GetObject().

SetScaleFactor()

bool WsfInherentContrast::SetScaleFactor ( WsfPlatform * aPlatformPtr, float aScaleFactor )

static

Set the signature scale factor.

Parameters

aPlatformPtr	[input] The pointer to the platform containing the signature.
aScaleFactor	[input] The new signature scale factor.

Returns

true if successful, false if and error occurred.

References cSIGNATURE_INDEX, WsfPlatform::GetSignatureList(), and WsfSignatureList::SetScaleFactor().

Referenced by GetInherentContrast().

SetState()

bool WsfInherentContrast::SetState ( WsfPlatform * aPlatformPtr, WsfStringId aState )

static

Set the signatures state

Parameters

aPlatformPtr	[input] The pointer to the platform containing the signature.
aState	[input] The new signatures state.

Returns

true if successful, false if and error occurred.

References cSIGNATURE_INDEX, WsfPlatform::GetSignatureList(), and WsfSignatureList::SetState().

Referenced by GetInherentContrast().

---

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

• WsfInherentContrast.hpp
• WsfInherentContrast.cpp