WSF
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
WsfEM_ALARM_Clutter Class Reference

Clutter model from ALARM. More...

#include <WsfEM_ALARM_Clutter.hpp>

Inheritance diagram for WsfEM_ALARM_Clutter:
Inheritance graph
[legend]
Collaboration diagram for WsfEM_ALARM_Clutter:
Collaboration graph
[legend]

Classes

class  LookSummary

Public Types

enum  { max_covers = 7 }
enum  { max_forms = 14 }
enum  { max_stat_opts = 5 }
using antenna = WsfEM_ALARM_Antenna::antenna
using atmosphere = WsfEM_ALARM_Attenuation::atmosphere
Public Types inherited from WsfObject
typedef std::vector< WsfStringId > TypeList
 The list of types returned by GetTypeList.

Public Member Functions

 WsfEM_ALARM_Clutter ()
WsfEM_ALARM_Clutter & operator= (const WsfEM_ALARM_Clutter &)=delete
 ~WsfEM_ALARM_Clutter () override=default
WsfEM_Clutter * Clone () const override
bool Initialize (WsfEM_Rcvr *aRcvrPtr) override
bool ProcessInput (UtInput &aInput) override
double ComputeClutterPower (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment, double aProcessingFactor) override
double GetSigmaC () const
double GetDecayConstant () const
const LookSummary & GetLookSummary ()
bool LookSummaryEnabled ()
Public Member Functions inherited from WsfEM_Clutter
 WsfEM_Clutter ()
 Constructor.
 ~WsfEM_Clutter () override=default
bool ProcessInput (UtInput &aInput) override
bool DebugEnabled () const
 Is 'debug' enabled?
virtual bool IsNullModel () const
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 WsfEM_Clutter * ObjectFactory (const std::string &aTypeName)
 Factory method called by WsfEM_ClutterTypes.
static void ResetState ()
 Reset all global/static data to default values.

Protected Member Functions

 WsfEM_ALARM_Clutter (const WsfEM_ALARM_Clutter &aSrc)
Protected Member Functions inherited from WsfEM_Clutter
 WsfEM_Clutter (const WsfEM_Clutter &aSrc)
 Copy constructor.
WsfEM_Clutter & operator= (const WsfEM_Clutter &aRhs)
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).

Detailed Description

Clutter model from ALARM.

Member Typedef Documentation

◆ antenna

using WsfEM_ALARM_Clutter::antenna = WsfEM_ALARM_Antenna::antenna

◆ atmosphere

using WsfEM_ALARM_Clutter::atmosphere = WsfEM_ALARM_Attenuation::atmosphere

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
max_forms 

◆ anonymous enum

anonymous enum
Enumerator
max_covers 

◆ anonymous enum

anonymous enum
Enumerator
max_stat_opts 

Constructor & Destructor Documentation

◆ WsfEM_ALARM_Clutter() [1/2]

WsfEM_ALARM_Clutter::WsfEM_ALARM_Clutter ( )

References WsfEM_Clutter::WsfEM_Clutter().

Referenced by Clone(), ObjectFactory(), operator=(), and WsfEM_ALARM_Clutter().

◆ ~WsfEM_ALARM_Clutter()

WsfEM_ALARM_Clutter::~WsfEM_ALARM_Clutter ( )
overridedefault

References WsfEM_Clutter::WsfEM_Clutter().

◆ WsfEM_ALARM_Clutter() [2/2]

WsfEM_ALARM_Clutter::WsfEM_ALARM_Clutter ( const WsfEM_ALARM_Clutter & aSrc)
protected

References WsfEM_ALARM_Clutter(), and WsfEM_Clutter::WsfEM_Clutter().

Member Function Documentation

◆ Clone()

WsfEM_Clutter * WsfEM_ALARM_Clutter::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 WsfEM_Clutter.

References WsfEM_ALARM_Clutter(), and WsfEM_Clutter::WsfEM_Clutter().

◆ ComputeClutterPower()

double WsfEM_ALARM_Clutter::ComputeClutterPower ( WsfEM_Interaction & aInteraction,
WsfEnvironment & aEnvironment,
double aProcessingFactor )
overridevirtual

Compute the clutter power for an interaction.

Parameters
aInteractionThe current interaction.
aEnvironmentThe environment (sea state, land formation, land coverage).
aProcessingFactorThe factor to be applied to the raw computed clutter power to produce the clutter power as seen by the radar AFTER is has performed clutter suppression. This value (in the range [0..1] represents the ability for the radar to attenuate (suppress) clutter returns. A value of zero indicates the clutter signal is completely attenuated while a value of one indicates that none of the clutter signal could be suppressed.

For the non-table models, the computed clutter power will be multiplied by this value to produce the return value. For table models the factor has probably already been included in the table and the value will probably be ignored.

Returns
The clutter power (watts).

Implements WsfEM_Clutter.

References WsfSimulationInput::AllowClutterCalculationShortcuts(), WsfEM_ALARM_Geometry::ComputeGeometry(), WsfEM_Types::cPOL_VERTICAL, WsfEM_Interaction::cRCVR_TERRAIN_MASKING, WsfEM_Interaction::cXMTR_TERRAIN_MASKING, deg2rad, fpicub, WsfEM_XmtrRcvr::GetAntennaPattern(), WsfAntennaPattern::GetAzimuthBeamwidth(), WsfEM_XmtrRcvr::GetFrequency(), WsfEM_XmtrRcvr::GetInternalLoss(), WsfEnvironment::GetLandCover(), WsfEnvironment::GetLandFormation(), WsfEM_XmtrRcvr::GetPeakAntennaGain(), WsfEM_XmtrRcvr::GetPlatform(), WsfEM_XmtrRcvr::GetPolarization(), WsfEM_Xmtr::GetPower(), WsfEM_XmtrRcvr::GetPropagationModel(), WsfEM_Xmtr::GetPulseCompressionRatio(), WsfEM_Xmtr::GetPulseRepetitionFrequency(), WsfEM_Xmtr::GetPulseWidth(), WsfEM_Interaction::GetReceiver(), WsfPlatform::GetScenario(), WsfEnvironment::GetSeaState(), WsfScenario::GetSimulationInput(), WsfEM_Interaction::GetTarget(), WsfPlatform::GetTerrain(), WsfEM_Interaction::GetTransmitter(), WsfEM_ALARM_Terrain::Initialize(), WsfEM_Interaction::MaskedByTerrain(), WsfEM_Interaction::mCheckedStatus, WsfEM_Interaction::mFailedStatus, WsfEM_Interaction::mPropagationFactor, WsfEM_Interaction::mRcvdPower, WsfEM_Interaction::mRcvrNoisePower, rad2deg, and vlight.

◆ GetDecayConstant()

double WsfEM_ALARM_Clutter::GetDecayConstant ( ) const
inline

◆ GetLookSummary()

const LookSummary & WsfEM_ALARM_Clutter::GetLookSummary ( )
inline

◆ GetSigmaC()

double WsfEM_ALARM_Clutter::GetSigmaC ( ) const
inline

◆ Initialize()

bool WsfEM_ALARM_Clutter::Initialize ( WsfEM_Rcvr * aRcvrPtr)
overridevirtual

Initialize the clutter object.

Parameters
aRcvrPtrThe receiver to which the clutter object is attached.

Reimplemented from WsfEM_Clutter.

References dble(), deg2rad, WsfEM_XmtrRcvr::GetArticulatedPart(), WsfScenario::GetEnvironment(), WsfObject::GetName(), WsfEM_XmtrRcvr::GetPlatform(), WsfPlatform::GetScenario(), WsfEM_XmtrRcvr::GetSimulation(), WsfEM_Clutter::Initialize(), and ok.

◆ LookSummaryEnabled()

bool WsfEM_ALARM_Clutter::LookSummaryEnabled ( )
inline

◆ ObjectFactory()

WsfEM_Clutter * WsfEM_ALARM_Clutter::ObjectFactory ( const std::string & aTypeName)
static

Factory method called by WsfEM_ClutterTypes.

References WsfEM_ALARM_Clutter(), and WsfEM_Clutter::WsfEM_Clutter().

◆ operator=()

WsfEM_ALARM_Clutter & WsfEM_ALARM_Clutter::operator= ( const WsfEM_ALARM_Clutter & )
delete

References WsfEM_ALARM_Clutter().

◆ ProcessInput()

bool WsfEM_ALARM_Clutter::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
aInputa 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 WsfEM_Clutter::ProcessInput(), and WsfEM_ALARM_Terrain::SetUseAFSIM_TerrainMasking().

◆ ResetState()

void WsfEM_ALARM_Clutter::ResetState ( )
static

Reset all global/static data to default values.

Referenced by WsfNonExportableBase::~WsfNonExportableBase().

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