An object that represents the infrared signature of a platform. More...

#include <WsfInfraredSignature.hpp>

Inheritance diagram for WsfInfraredSignature:

[legend]

Collaboration diagram for WsfInfraredSignature:

[legend]

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

Public Member Functions
	WsfInfraredSignature ()
WsfInfraredSignature *	Clone () const override=0
virtual float	GetSignature (double aSimTime, WsfStringId aStateId, WsfEM_Types::InfraredBand aBand, 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 WsfInfraredSignature::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 (double aSimTime, WsfPlatform *aPlatformPtr, WsfEM_Types::InfraredBand aBand, double aAzimuth, double aElevation)
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 infrared signature of a platform.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Constructor & Destructor Documentation

◆ WsfInfraredSignature()

WsfInfraredSignature::WsfInfraredSignature ( )

References WsfSignature::WsfSignature().

Referenced by Clone(), WsfStandardInfraredSignature::Clone(), GetValue(), WsfStandardInfraredSignature::ObjectFactory(), and WsfStandardInfraredSignature::WsfStandardInfraredSignature().

Member Function Documentation

◆ Clone()

WsfInfraredSignature * WsfInfraredSignature::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 WsfStandardInfraredSignature.

References WsfInfraredSignature().

◆ GetInputType()

WsfStringId WsfInfraredSignature::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 GetSignature().

◆ GetScaleFactor()

float WsfInfraredSignature::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 GetSignature().

◆ GetSignature()

virtual float WsfInfraredSignature::GetSignature	(	double	aSimTime,
		WsfStringId	aStateId,
		WsfEM_Types::InfraredBand	aBand,
		double	aAzimuth,
		double	aElevation )

pure virtual

Get the infrared cross section.

Parameters

aSimTime	[input] The current simulation time.
aStateId	[input] The string ID representing the signature state to be used.
aBand	[input] infrared band.
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 infrared cross section (m^2)

Implemented in WsfStandardInfraredSignature.

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

Referenced by GetValue().

◆ GetState()

WsfStringId WsfInfraredSignature::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 GetSignature().

◆ GetValue()

float WsfInfraredSignature::GetValue	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr,
		WsfEM_Types::InfraredBand	aBand,
		double	aAzimuth,
		double	aElevation )

static

Get the signature value for a set of conditions.

Parameters

aSimTime	[input] The current simulation time.
aPlatformPtr	[input] The platform from which the signature is to be retrieved.
aBand	[input] infrared band.
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 infrared signature.

References cSIGNATURE_INDEX, WsfObject::GetName(), GetSignature(), WsfPlatform::GetSignatureList(), WsfObject::GetType(), and WsfInfraredSignature().

Referenced by WsfEOIR_IRST_SensorMode::AttemptToDetectInfrared(), and GetSignature().

◆ RegisterInterface()

void WsfInfraredSignature::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 GetSignature(), and WsfInfraredSignatureTypes::WsfInfraredSignatureTypes().

◆ RegisterScriptMethods()

void WsfInfraredSignature::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 GetSignature().

◆ SetScaleFactor()

bool WsfInfraredSignature::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 GetSignature().

◆ SetState()

bool WsfInfraredSignature::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 GetSignature().

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

Public Types

Public Member Functions

Methods to support the actual interface on the platform.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ WsfInfraredSignature()

Member Function Documentation

◆ Clone()

◆ GetInputType()

◆ GetScaleFactor()

◆ GetSignature()

◆ GetState()

◆ GetValue()

◆ RegisterInterface()

◆ RegisterScriptMethods()

◆ SetScaleFactor()

◆ SetState()