#include <WsfEM_SurfaceClutterTable.hpp>

Inheritance diagram for WsfEM_SurfaceClutterTable:

[legend]

Collaboration diagram for WsfEM_SurfaceClutterTable:

[legend]

Public Types
enum	Type { cUNDEFINED = 0 , cCONSTANT , cGENERIC , cSITE_SPECIFIC }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfEM_SurfaceClutterTable ()
	~WsfEM_SurfaceClutterTable () override
WsfEM_Clutter *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
Type	GetType () const
	Return the table type.
double	ComputeClutterPower (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment, double aProcessingFactor) override
Public Member Functions inherited from WsfEM_Clutter
	WsfEM_Clutter ()
	Constructor.
	~WsfEM_Clutter () override=default
virtual bool	Initialize (WsfEM_Rcvr *aRcvrPtr)
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.

Protected Member Functions
	WsfEM_SurfaceClutterTable (const WsfEM_SurfaceClutterTable &aSrc)
WsfEM_SurfaceClutterTable &	operator= (const WsfEM_SurfaceClutterTable &aRhs)
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

This class defines a clutter table as a function of altitude and range

Clutter tables are used by receivers of electromagnetic radiation to determine how much noise is added to the received signal due to ground (or sea) clutter.

A given clutter table object will be shared amongst all objects that utilize the table.

Member Enumeration Documentation

◆ Type

enum WsfEM_SurfaceClutterTable::Type

Enumerator
cUNDEFINED
cCONSTANT
cGENERIC
cSITE_SPECIFIC

Constructor & Destructor Documentation

◆ WsfEM_SurfaceClutterTable() [1/2]

WsfEM_SurfaceClutterTable::WsfEM_SurfaceClutterTable ( )

References cUNDEFINED, and WsfEM_Clutter::WsfEM_Clutter().

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

◆ ~WsfEM_SurfaceClutterTable()

WsfEM_SurfaceClutterTable::~WsfEM_SurfaceClutterTable ( )

override

◆ WsfEM_SurfaceClutterTable() [2/2]

WsfEM_SurfaceClutterTable::WsfEM_SurfaceClutterTable ( const WsfEM_SurfaceClutterTable & aSrc )

protected

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

Member Function Documentation

◆ Clone()

WsfEM_Clutter * WsfEM_SurfaceClutterTable::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_Clutter::WsfEM_Clutter(), and WsfEM_SurfaceClutterTable().

◆ ComputeClutterPower()

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

overridevirtual

Compute the clutter power for an interaction.

Parameters

aInteraction	The current interaction.
aEnvironment	The environment (sea state, land formation, land coverage).
aProcessingFactor	The 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 cSITE_SPECIFIC, WsfEM_Clutter::DebugEnabled(), WsfEM_XmtrRcvr::GetPlatform(), WsfEM_Interaction::GetReceiver(), WsfEM_Interaction::LocationData::mAlt, WsfEM_Interaction::LocationData::mLocWCS, WsfEM_Interaction::mRcvrLoc, WsfEM_Interaction::mRcvrToTgt, WsfEM_Interaction::mTgtLoc, and WsfEM_Interaction::RelativeData::mTrueUnitVecWCS.

◆ GetType()

Type WsfEM_SurfaceClutterTable::GetType ( ) const

inline

Return the table type.

◆ ObjectFactory()

WsfEM_Clutter * WsfEM_SurfaceClutterTable::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfEM_ClutterTypes.

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

Referenced by WsfEM_ClutterTypes::WsfEM_ClutterTypes().

◆ operator=()

WsfEM_SurfaceClutterTable & WsfEM_SurfaceClutterTable::operator= ( const WsfEM_SurfaceClutterTable & aRhs )

protected

References WsfEM_Clutter::operator=(), and WsfEM_SurfaceClutterTable().

◆ ProcessInput()

bool WsfEM_SurfaceClutterTable::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 WsfEM_Clutter.

References cCONSTANT, cGENERIC, cUNDEFINED, and WsfEM_Clutter::ProcessInput().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ WsfEM_SurfaceClutterTable() [1/2]

◆ ~WsfEM_SurfaceClutterTable()

◆ WsfEM_SurfaceClutterTable() [2/2]

Member Function Documentation

◆ Clone()

◆ ComputeClutterPower()

◆ GetType()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()