#include <WsfEM_ALARM_Propagation.hpp>

Inheritance diagram for WsfEM_ALARM_Propagation:

[legend]

Collaboration diagram for WsfEM_ALARM_Propagation:

[legend]

Public Member Functions
	WsfEM_ALARM_Propagation ()
WsfEM_ALARM_Propagation &	operator= (const WsfEM_ALARM_Propagation &)=delete
	~WsfEM_ALARM_Propagation () override=default
WsfEM_Propagation *	Clone () const override
double	ComputePropagationFactor (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment) override
bool	Initialize (WsfEM_XmtrRcvr *aXmtrRcvrPtr) override
bool	ProcessInput (UtInput &aInput) override
Public Member Functions inherited from WsfEM_Propagation
	WsfEM_Propagation ()
	Constructor.
	~WsfEM_Propagation () override=default
const char *	GetScriptClassName () const override
bool	DebugEnabled () const
	Is 'debug' enabled?
virtual bool	Initialize (WsfEM_Xmtr *aXmtrPtr)
bool	ProcessInput (UtInput &aInput) override
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 void	ResetState ()
	Reset all the global/static data to default values.
static WsfEM_Propagation *	ObjectFactory (const std::string &aTypeName)
	Factory method called by WsfEM_PropagationTypes.

Protected Member Functions
	WsfEM_ALARM_Propagation (const WsfEM_ALARM_Propagation &aSrc)
Protected Member Functions inherited from WsfEM_Propagation
	WsfEM_Propagation (const WsfEM_Propagation &aSrc)
	Copy constructor.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Attributes inherited from WsfEM_Propagation
bool	mDebugEnabled

Detailed Description

An interface to the ALARM propagation methods.

Note: This code is NON-EXPORTABLE!

Constructor & Destructor Documentation

◆ WsfEM_ALARM_Propagation() [1/2]

WsfEM_ALARM_Propagation::WsfEM_ALARM_Propagation ( )

References WsfEM_Propagation::WsfEM_Propagation().

Referenced by Clone(), ObjectFactory(), operator=(), WsfEM_ALARM_Propagation(), and ~WsfEM_ALARM_Propagation().

◆ ~WsfEM_ALARM_Propagation()

WsfEM_ALARM_Propagation::~WsfEM_ALARM_Propagation ( )

overridedefault

References gamma, WsfEM_ALARM_Propagation(), and WsfEM_Propagation::WsfEM_Propagation().

◆ WsfEM_ALARM_Propagation() [2/2]

WsfEM_ALARM_Propagation::WsfEM_ALARM_Propagation ( const WsfEM_ALARM_Propagation & aSrc )

protected

References WsfEM_ALARM_Propagation(), and WsfEM_Propagation::WsfEM_Propagation().

Member Function Documentation

◆ Clone()

WsfEM_Propagation * WsfEM_ALARM_Propagation::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_Propagation.

References WsfEM_ALARM_Propagation(), and WsfEM_Propagation::WsfEM_Propagation().

◆ ComputePropagationFactor()

double WsfEM_ALARM_Propagation::ComputePropagationFactor	(	WsfEM_Interaction &	aInteraction,
		WsfEnvironment &	aEnvironment )

overridevirtual

Compute the propagation factor for the current interaction.

Parameters

aInteraction	The current interaction.
aEnvironment	The environment (sea state, land formation, land coverage).

Returns: The pattern propagation factor (F40) as a linear value (not dB).

Implements WsfEM_Propagation.

References cabs(), WsfEM_ALARM_Geometry::ComputeGeometry(), WsfEM_Types::cPOL_HORIZONTAL, WsfEM_Types::cPOL_LEFT_CIRCULAR, WsfEM_Types::cPOL_RIGHT_CIRCULAR, WsfEM_Types::cPOL_SLANT_135, WsfEM_Types::cPOL_SLANT_45, WsfEM_Types::cPOL_VERTICAL, WsfEM_Interaction::cRCVR_TERRAIN_MASKING, WsfEM_Rcvr::cRF_PASSIVE_SENSOR, WsfEM_Interaction::cXMTR_TERRAIN_MASKING, WsfEM_Propagation::DebugEnabled(), WsfEM_ALARM_Terrain::get_ground_range_incr(), WsfEM_XmtrRcvr::GetFrequency(), WsfEM_Rcvr::GetFunction(), WsfEnvironment::GetLandCover(), WsfEnvironment::GetLandFormation(), WsfEM_XmtrRcvr::GetPlatform(), WsfEM_XmtrRcvr::GetPolarization(), WsfEM_Xmtr::GetPulseWidth(), WsfEM_Interaction::GetReceiver(), WsfEnvironment::GetSeaState(), WsfPlatform::GetSpatialDomain(), WsfEM_Interaction::GetTarget(), WsfPlatform::GetTerrain(), WsfEM_Interaction::GetTransmitter(), WsfEnvironment::GetWindSpeed(), WsfEM_ALARM_Terrain::Initialize(), WsfEM_Interaction::mBistatic, WsfEM_Interaction::mFailedStatus, onethr, pi, pol_default, pol_horizontal, pol_lh_circular, pol_rh_circular, pol_slant_135, pol_slant_45, pol_vertical, WSF_SPATIAL_DOMAIN_SUBSURFACE, and WSF_SPATIAL_DOMAIN_SURFACE.

◆ Initialize()

bool WsfEM_ALARM_Propagation::Initialize ( WsfEM_XmtrRcvr * aXmtrRcvrPtr )

overridevirtual

Initialize the propagation object.

Parameters

aXmtrRcvrPtr The transmitter/receiver to which the propagation object is attached.

Reimplemented from WsfEM_Propagation.

References WsfEM_XmtrRcvr::GetSimulation(), WsfEM_Propagation::Initialize(), and ok.

◆ ObjectFactory()

WsfEM_Propagation * WsfEM_ALARM_Propagation::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfEM_PropagationTypes.

References WsfEM_ALARM_Propagation(), and WsfEM_Propagation::WsfEM_Propagation().

◆ operator=()

WsfEM_ALARM_Propagation & WsfEM_ALARM_Propagation::operator= ( const WsfEM_ALARM_Propagation & )

delete

References WsfEM_ALARM_Propagation().

◆ ProcessInput()

bool WsfEM_ALARM_Propagation::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 WsfEM_Propagation::ProcessInput(), and WsfEM_ALARM_Terrain::SetUseAFSIM_TerrainMasking().

◆ ResetState()

void WsfEM_ALARM_Propagation::ResetState ( )

static

Reset all the global/static data to default values.

Referenced by WsfNonExportableBase::~WsfNonExportableBase().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfEM_ALARM_Propagation() [1/2]

◆ ~WsfEM_ALARM_Propagation()

◆ WsfEM_ALARM_Propagation() [2/2]

Member Function Documentation

◆ Clone()

◆ ComputePropagationFactor()

◆ Initialize()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()

◆ ResetState()