WSF
WsfChaffRadarSignature Class Reference

#include <WsfChaffRadarSignature.hpp>

Inheritance diagram for WsfChaffRadarSignature:
Collaboration diagram for WsfChaffRadarSignature:

Public Member Functions

 WsfChaffRadarSignature ()
WsfRadarSignatureClone () const 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
bool Initialize (double aSimTime, WsfPlatform *aPlatformPtr) override
Public Member Functions inherited from WsfRadarSignature
 WsfRadarSignature ()
Public Member Functions inherited from WsfSignature
 WsfSignature ()
 WsfSignature (const WsfSignature &aSrc)
WsfSignatureoperator= (const WsfSignature &)=delete
 ~WsfSignature () override=default
virtual bool InitializeType ()
virtual bool IsA_ValidState (WsfStringId aId) const
virtual std::vector< WsfStringIdGetStateNames () 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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)

Additional Inherited Members

Public Types inherited from WsfRadarSignature
enum  { cSIGNATURE_INDEX = 0 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
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 WsfRadarSignatureGetSignature (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.
 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< WsfStringIdGetStateNamesP (Iterator aBegin, Iterator aEnd)
Protected Attributes inherited from WsfSignature
WsfPlatformmPlatformPtr
double mBaseTime
bool mRequiresPlatform {false}

Constructor & Destructor Documentation

◆ WsfChaffRadarSignature()

WsfChaffRadarSignature::WsfChaffRadarSignature ( )

References WsfRadarSignature::WsfRadarSignature().

Referenced by Clone().

Member Function Documentation

◆ Clone()

WsfRadarSignature * WsfChaffRadarSignature::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 WsfChaffRadarSignature(), and WsfRadarSignature::WsfRadarSignature().

◆ GetSignature()

float WsfChaffRadarSignature::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.

References WsfEM_XmtrRcvr::GetAntenna(), and WsfEM_Antenna::GetLocationWCS().

◆ GetSignatureLimits()

std::pair< float, float > WsfChaffRadarSignature::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.

◆ Initialize()

bool WsfChaffRadarSignature::Initialize ( double aSimTime,
WsfPlatform * aPlatformPtr )
overridevirtual

Initialize an instance to prepare for use in a simulation.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform to which the instance is attached.
Returns
true if successful.

Reimplemented from WsfSignature.

References WsfChaffParcel::Find(), WsfObject::GetName(), and WsfObject::GetType().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved