A collection of one or more radar signature tables that represent the radar signature of a platform. More...

#include <WsfMilRadarSignature.hpp>

Inheritance diagram for WsfMilRadarSignature:

[legend]

Collaboration diagram for WsfMilRadarSignature:

[legend]

Classes
class	Table
	A 'Table' represents the signature for a given frequency limit. More...
class	State
	A 'State' represents all of the tables for a given signature state. More...

Public Types
using	TableSet = std::vector<Table>
using	TableIndex = std::vector<Table>::size_type
using	States = std::vector<State>
using	StateIndex = std::vector<State>::size_type
Public Types inherited from WsfRadarSignature
enum	{ cSIGNATURE_INDEX = 0 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfMilRadarSignature ()
WsfRadarSignature *	Clone () const override
bool	InitializeType () override
std::vector< WsfStringId >	GetStateNames () const override
	get the list of all valid states belonging to the signature
bool	ProcessInput (UtInput &aInput) override
float	GetSignature (WsfStringId aStateId, WsfEM_Types::Polarization aPolarization, double aFrequency, double aTgtToXmtrAz, double aTgtToXmtrEl, double aTgtToRcvrAz, double aTgtToRcvrEl, WsfEM_Xmtr aXmtrPtr=nullptr, WsfEM_Rcvr aRcvrPtr=nullptr) override
std::pair< float, float >	GetSignatureLimits (WsfStringId aStateId, WsfEM_Types::Polarization aPolarization) const override
const States &	GetStates () const
bool	AddTable (UtAzElTable *aTablePtr, WsfStringId aStateId, WsfEM_Types::Polarization aPolarization, double aFrequencyLimit)
void	SelectTable (UtAzElLookup &aContext, WsfStringId aState, WsfEM_Types::Polarization aPolarization, double aFrequency)
Public Member Functions inherited from WsfRadarSignature
	WsfRadarSignature ()
Public Member Functions inherited from WsfSignature
	WsfSignature ()
	WsfSignature (const WsfSignature &aSrc)
WsfSignature &	operator= (const WsfSignature &)=delete
	~WsfSignature () override=default
virtual bool	Initialize (double aSimTime, WsfPlatform *aPlatformPtr)
virtual bool	IsA_ValidState (WsfStringId aId) const
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)

Static Public Member Functions
static WsfRadarSignature *	ObjectFactory (const std::string &aTypeName)
	Factory method called by WsfRadarSignatureTypes.
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, WsfEM_Types::Polarization aPolarization, double aFrequency, double aTgtToXmtrAz, double aTgtToXmtrEl, double aTgtToRcvrAz, double aTgtToRcvrEl)
static float	GetValue (WsfPlatform aPlatformPtr, WsfEM_Xmtr aXmtrPtr, WsfEM_Rcvr *aRcvrPtr, double aTgtToXmtrAz, double aTgtToXmtrEl, double aTgtToRcvrAz, double aTgtToRcvrEl)
static WsfRadarSignature *	GetSignature (WsfPlatform *aPlatformPtr)
static bool	SetSignature (WsfPlatform aPlatformPtr, WsfRadarSignature aSignaturePtr)
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

A collection of one or more radar signature tables that represent the radar signature of a platform.

Member Typedef Documentation

◆ StateIndex

using WsfMilRadarSignature::StateIndex = std::vector<State>::size_type

◆ States

using WsfMilRadarSignature::States = std::vector<State>

◆ TableIndex

using WsfMilRadarSignature::TableIndex = std::vector<Table>::size_type

◆ TableSet

using WsfMilRadarSignature::TableSet = std::vector<Table>

A 'TableSet' is just a collection of 'Table's. This represents the collection of tables for a given polarization within a signature state.

Constructor & Destructor Documentation

◆ WsfMilRadarSignature()

WsfMilRadarSignature::WsfMilRadarSignature ( )

References WsfRadarSignature::WsfRadarSignature().

Referenced by Clone().

Member Function Documentation

◆ AddTable()

bool WsfMilRadarSignature::AddTable	(	UtAzElTable *	aTablePtr,
		WsfStringId	aStateId,
		WsfEM_Types::Polarization	aPolarization,
		double	aFrequencyLimit )

Add a table to the definition.

Parameters

aTablePtr	Pointer to the table to be added.
aStateId	String ID of the state name for which the table applies.
aPolarization	Signal polarization to which the table applies.
aFrequencyLimit	Upper bound of the frequency to which the table applies.

Returns: true if table added or false if a table for the requested state/polarization

Note: This is provided to allow an application to dynamically create a signature. It is intended only for very simple uses such as in sensor_plot RadarEnvelopeFunction. It is NOT a general purpose method.

◆ Clone()

WsfRadarSignature * WsfMilRadarSignature::Clone ( ) const

overridevirtual

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

Implements WsfRadarSignature.

References WsfMilRadarSignature(), and WsfRadarSignature::WsfRadarSignature().

◆ GetSignature()

float WsfMilRadarSignature::GetSignature	(	WsfStringId	aStateId,
		WsfEM_Types::Polarization	aPolarization,
		double	aFrequency,
		double	aTgtToXmtrAz,
		double	aTgtToXmtrEl,
		double	aTgtToRcvrAz,
		double	aTgtToRcvrEl,
		WsfEM_Xmtr *	aXmtrPtr = nullptr,
		WsfEM_Rcvr *	aRcvrPtr = nullptr )

overridevirtual

Get the radar signature for a given set of conditions.

Parameters

aStateId	[input] The string ID representing the signature state to be used.
aPolarization	[input] The polarization of the signal.
aFrequency	[input] The frequency of the signal (Hz).
aTgtToXmtrAz	[input] The azimuth of the transmitter with respect to the target.
aTgtToXmtrEl	[input] The elevation of the transmitter with respect to the target.
aTgtToRcvrAz	[input] The azimuth of the receiver with respect to the target.
aTgtToRcvrEl	[input] The elevation of the receiver with respect to the target.
aXmtrPtr	[input] Optional pointer to the transmitter
aRcvrPtr	[input] Optional pointer to the receiver

Returns: The radar cross section (m^2)

Implements WsfRadarSignature.

◆ GetSignatureLimits()

std::pair< float, float > WsfMilRadarSignature::GetSignatureLimits	(	WsfStringId	aStateId,
		WsfEM_Types::Polarization	aPolarization ) const

overridevirtual

Get the min and max radar cross section values that can be returned by GetSignature for the given signature state and polarization.

Reimplemented from WsfRadarSignature.

◆ GetStateNames()

std::vector< WsfStringId > WsfMilRadarSignature::GetStateNames ( ) const

overridevirtual

get the list of all valid states belonging to the signature

Reimplemented from WsfSignature.

References WsfSignature::GetStateNamesP(), and GetStates().

◆ GetStates()

const std::vector< WsfMilRadarSignature::State > & WsfMilRadarSignature::GetStates ( ) const

Returns: The signatures for all of defined states.

Note: This method was created to allow applications access to signature data. It should not be used to look up signatures.

Referenced by GetStateNames().

◆ InitializeType()

bool WsfMilRadarSignature::InitializeType ( )

overridevirtual

Initialize an signature 'type' instance. This is called by WsfObjectTypeList::LoadType after all the input for the instance has been read.

Returns: true if successful.

Reimplemented from WsfSignature.

References WsfSignature::InitializeType(), and ok.

◆ ObjectFactory()

WsfRadarSignature * WsfMilRadarSignature::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfRadarSignatureTypes.

References WsfRadarSignature::WsfRadarSignature().

Referenced by WsfMilExtension::AddedToScenario().

◆ ProcessInput()

bool WsfMilRadarSignature::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References WsfObject::ProcessInput().

◆ SelectTable()

void WsfMilRadarSignature::SelectTable	(	UtAzElLookup &	aContext,
		WsfStringId	aState,
		WsfEM_Types::Polarization	aPolarization,
		double	aFrequency )

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ StateIndex

◆ States

◆ TableIndex

◆ TableSet

Constructor & Destructor Documentation

◆ WsfMilRadarSignature()

Member Function Documentation

◆ AddTable()

◆ Clone()

◆ GetSignature()

◆ GetSignatureLimits()

◆ GetStateNames()

◆ GetStates()

◆ InitializeType()

◆ ObjectFactory()

◆ ProcessInput()

◆ SelectTable()