#include <WsfEM_Attenuation.hpp>

Inheritance diagram for WsfEM_Attenuation:

[legend]

Collaboration diagram for WsfEM_Attenuation:

Public Member Functions
	WsfEM_Attenuation ()
	~WsfEM_Attenuation () override
WsfEM_Attenuation *	Clone () const override=0
virtual bool	Initialize (WsfEM_XmtrRcvr *aXmtrRcvrPtr)
virtual bool	Initialize (WsfEM_Xmtr *aXmtrPtr)
bool	ProcessInput (UtInput &aInput) override
const char *	GetScriptClassName () const override
bool	DebugEnabled () const
	Is 'debug' enabled?
virtual bool	IsNullModel () const
virtual bool	AcceptsInlineBlockInput () const
virtual double	ComputeAttenuationFactor (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment, WsfEM_Interaction::Geometry aGeometry)
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)

Protected Member Functions
	WsfEM_Attenuation (const WsfEM_Attenuation &aSrc)
virtual double	ComputeAttenuationFactorP (double aRange, double aElevation, double aAltitude, double aFrequency)
void	GetAltitudesAndGroundRange (WsfEM_Interaction &aInteraction, WsfEM_Interaction::Geometry aGeometry, double &aAltitude1, double &aAltitude2, double &aGroundRange)
void	GetRangeElevationAltitude (WsfEM_Interaction &aInteraction, WsfEM_Interaction::Geometry aGeometry, double &aRange, double &aElevation, double &aAltitude)
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Protected Attributes
bool	mDebugEnabled
bool	mSortEndPoints

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

Detailed Description

Base Class definition for the Atmospheric Attenuation (Absorption) Model. Returns a factor that indicates no attenuation by default.

Constructor & Destructor Documentation

◆ WsfEM_Attenuation() [1/2]

WsfEM_Attenuation::WsfEM_Attenuation ( )

References mDebugEnabled, mSortEndPoints, and WsfObject::WsfObject().

◆ ~WsfEM_Attenuation()

WsfEM_Attenuation::~WsfEM_Attenuation ( )

override

◆ WsfEM_Attenuation() [2/2]

WsfEM_Attenuation::WsfEM_Attenuation ( const WsfEM_Attenuation & aSrc )

protected

References mDebugEnabled, mSortEndPoints, WsfEM_Attenuation(), and WsfObject::WsfObject().

Member Function Documentation

◆ AcceptsInlineBlockInput()

virtual bool WsfEM_Attenuation::AcceptsInlineBlockInput ( ) const

inlinevirtual

Does the accept inline block input?

This is called by WsfEM_Attenuation::LoadReference when attempting to load a reference to an attenuation model from within another object (i.e.: a 'transmitter').

When originally developed none of the models required additional input, and the command stream was simply 'attenuation_model <x>'. Some of the newer models however have optional inputs that may be provided and thus require the 'block' input (i.e.: they require a 'end_attenuation_model' terminator. Models that have optional inputs should return 'true'.

Reimplemented in WsfEM_ITU_Attenuation, WsfEM_SimpleAttenuation, and WsfTabularAttenuation.

◆ Clone()

WsfEM_Attenuation * WsfEM_Attenuation::Clone ( ) const

overridepure virtual

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

Implements WsfObject.

Implemented in WsfEM_BlakeAttenuation, WsfEM_EARCE_Attenuation, WsfEM_ITU_Attenuation, WsfEM_RF_Type1Attenuation, WsfEM_SimpleAttenuation, WsfOpticalAttenuation, and WsfTabularAttenuation.

References Initialize(), and WsfEM_Attenuation().

◆ ComputeAttenuationFactor()

double WsfEM_Attenuation::ComputeAttenuationFactor	(	WsfEM_Interaction &	aInteraction,
		WsfEnvironment &	aEnvironment,
		WsfEM_Interaction::Geometry	aGeometry )

virtual

Compute the attenuation loss factor along a specified path segment.

Parameters

aInteraction	The WsfEM_Interaction object containing all geometry needed to perform the calculation.
aEnvironment	The environment object (for future use to determine inhomogeneous conditions).
aGeometry	Indicates which segment of the path is to be computed (Xmtr->Tgt, Tgt->Rcvr or Xmtr->Rcvr).

Returns: The fraction of the signal that remains at the end of the segment, in the range [0, 1].

Note: This is the public interface to the attenuation calculations that is called by WsfEM_Interaction. A derived class may implement this method for the most general capabilities, or may implement the protected 4-argument form which is called by the base class implementation of this form.

Reimplemented in WsfEM_ITU_Attenuation, WsfOpticalAttenuation, and WsfTabularAttenuation.

References ComputeAttenuationFactorP(), WsfEM_Rcvr::cRF_PASSIVE_SENSOR, WsfEM_XmtrRcvr::GetFrequency(), WsfEM_Rcvr::GetFunction(), GetRangeElevationAltitude(), WsfEM_Interaction::GetReceiver(), and WsfEM_Interaction::GetTransmitter().

Referenced by WsfEM_ALARM_Attenuation::atmosphere::attenuation().

◆ ComputeAttenuationFactorP()

double WsfEM_Attenuation::ComputeAttenuationFactorP	(	double	aRange,
		double	aElevation,
		double	aAltitude,
		double	aFrequency )

protectedvirtual

Compute the attenuation loss factor along a specified path.

Parameters

aRange	The range over which the signal will travel (meters)
aElevation	The elevation angle above the horizontal plane that is tangent to the Earth's surface (radians)
aAltitude	The altitude of the lowest point between the two points under consideration. This altitude must be lowest as some models assume it.
aFrequency	The frequency of the signal (hertz).

Returns: The fraction of the signal that remains at the end of the path, in the range [0, 1].

Note: This form is NOT called directly by the routines in WsfEM_Interaction (they call the 3-argument form). The base class 3-argument form calls this form, which as a signature that is typical for many RF models.; This form is protected and can ONLY be called by the base class 3-argument form.

Reimplemented in WsfEM_BlakeAttenuation, WsfEM_EARCE_Attenuation, and WsfEM_RF_Type1Attenuation.

Referenced by ComputeAttenuationFactor().

◆ DebugEnabled()

bool WsfEM_Attenuation::DebugEnabled ( ) const

inline

Is 'debug' enabled?

References mDebugEnabled.

◆ GetAltitudesAndGroundRange()

void WsfEM_Attenuation::GetAltitudesAndGroundRange	(	WsfEM_Interaction &	aInteraction,
		WsfEM_Interaction::Geometry	aGeometry,
		double &	aAltitude1,
		double &	aAltitude2,
		double &	aGroundRange )

protected

Get the altitudes and ground range of the objects in an interaction.

Parameters

aInteraction	The interaction object.
aGeometry	An enum representing the participants.
aAltitude1	[output] The altitude of the observer object (see note below)
aAltitude2	[output] The altitude of the observee object (see note below)
aGroundRange	[output] The ground range between the participants.

Note: The geometry enumeration specifies the signal path with the first point being the emitting source (i.e.: the transmitter or the radiating or reflecting target). In this context, we have a slightly different view. If the interaction involves a reciever then the receiver is considered the observer and the other object is considered the observee. If the interation is transmitter-to- target then the transmitter is the observer.

This is not important if 'sort_end_points' is 'true' as the first altitude will always be the lower of the two altitudes. 'sort_end_points' is typically false only by explicit user-input in WsfTabularAttenuation when the does not assume that paths are symmetic.

References WsfEM_Interaction::cTARGET_TO_RCVR, WsfEM_Interaction::cXMTR_TO_RCVR, WsfEM_Interaction::cXMTR_TO_TARGET, WsfEM_Interaction::LocationData::mAlt, WsfEM_Interaction::LocationData::mLocWCS, WsfEM_Interaction::mRcvrLoc, mSortEndPoints, WsfEM_Interaction::mTgtLoc, WsfEM_Interaction::mXmtrLoc, and std::swap().

Referenced by WsfOpticalAttenuation::ComputeAttenuationFactor(), and WsfTabularAttenuation::ComputeAttenuationFactor().

◆ GetRangeElevationAltitude()

void WsfEM_Attenuation::GetRangeElevationAltitude	(	WsfEM_Interaction &	aInteraction,
		WsfEM_Interaction::Geometry	aGeometry,
		double &	aRange,
		double &	aElevation,
		double &	aAltitude )

protected

Get the slant range, elevation and altitude between an observer and another object.

Parameters

aInteraction	The interaction object.
aGeometry	An enum representing the participants.
aRange	[output] The slant range between the objects.
aElevation	[output] The elevation angle from the observer to the object being observed.
aAltitude	[output] The altitude of the observer.

Note: The geometry enumeration specifies the signal path with the first point being the emitting source (i.e.: the transmitter or the radiating or reflecting target). In this context, we have a slightly different view. If the interaction involves a reciever then the receiver is considered the observer and the other object is considered the observee. If the interation is transmitter-to- target then the transmitter is the observer.

This is not important if 'sort_end_points' is 'true' as the altitude will always be the lower of the two altitudes and the elevation angle will be computed relative to object at the lower altitude. 'sort_end_points' is typically false only by explicit user-input in WsfTabularAttenuation when the table does not assume paths are symmetric.

Referenced by ComputeAttenuationFactor(), WsfEM_ITU_Attenuation::ComputeAttenuationFactor(), WsfOpticalAttenuation::ComputeAttenuationFactor(), WsfTabularAttenuation::ComputeAttenuationFactor(), and GetRangeElevationAltitude().

◆ GetScriptClassName()

const char * WsfEM_Attenuation::GetScriptClassName ( ) const

inlineoverride

◆ Initialize() [1/2]

bool WsfEM_Attenuation::Initialize ( WsfEM_Xmtr * aXmtrPtr )

virtual

Initialize the attenuation object.

Parameters

aXmtrPtr The transmitter to which the attenuation object is attached.

Note: This method is deprecated and is provided simply so existing models will continue to function. All new models should use the form that accepts a WsfEM_XmtrRcvr.

References Initialize().

◆ Initialize() [2/2]

bool WsfEM_Attenuation::Initialize ( WsfEM_XmtrRcvr * aXmtrRcvrPtr )

virtual

Initialize the attenuation object.

Parameters

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

Reimplemented in WsfEM_RF_Type1Attenuation, WsfOpticalAttenuation, and WsfTabularAttenuation.

Referenced by Clone(), Initialize(), WsfEOIR_IRST_SensorMode::Initialize(), WsfOpticalAttenuation::Initialize(), and WsfTabularAttenuation::Initialize().

◆ IsNullModel()

virtual bool WsfEM_Attenuation::IsNullModel ( ) const

inlinevirtual

Is the object a 'null' (no-effect) clutter model? No operational model needs to worry about this method.

Note: See the code in WsfEM_Attenuation as to why this is present.

◆ ProcessInput()

bool WsfEM_Attenuation::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.

Reimplemented in WsfEM_ITU_Attenuation, WsfEM_SimpleAttenuation, WsfOpticalAttenuation, and WsfTabularAttenuation.

References mDebugEnabled.

Referenced by WsfEM_ITU_Attenuation::ProcessInput(), WsfEM_SimpleAttenuation::ProcessInput(), WsfOpticalAttenuation::ProcessInput(), and WsfTabularAttenuation::ProcessInput().

Member Data Documentation

◆ mDebugEnabled

bool WsfEM_Attenuation::mDebugEnabled

protected

Referenced by DebugEnabled(), ProcessInput(), WsfEM_Attenuation(), and WsfEM_Attenuation().

◆ mSortEndPoints

bool WsfEM_Attenuation::mSortEndPoints

protected

True if the end points of the path should be sorted so the path goes from the lowest to highest point. The default in the base class is 'true' and provides no means for the user to change it. Derived classes may change the default and may provide means for the user to change it.

Referenced by GetAltitudesAndGroundRange(), WsfTabularAttenuation::ProcessInput(), WsfEM_Attenuation(), WsfEM_Attenuation(), and WsfTabularAttenuation::WsfTabularAttenuation().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfEM_Attenuation() [1/2]

◆ ~WsfEM_Attenuation()

◆ WsfEM_Attenuation() [2/2]

Member Function Documentation

◆ AcceptsInlineBlockInput()

◆ Clone()

◆ ComputeAttenuationFactor()

◆ ComputeAttenuationFactorP()

◆ DebugEnabled()

◆ GetAltitudesAndGroundRange()

◆ GetRangeElevationAltitude()

◆ GetScriptClassName()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ IsNullModel()

◆ ProcessInput()

Member Data Documentation

◆ mDebugEnabled

◆ mSortEndPoints