WsfEM_ITU_Attenuation Class Reference

#include <WsfEM_ITU_Attenuation.hpp>

Inheritance diagram for WsfEM_ITU_Attenuation:

Collaboration diagram for WsfEM_ITU_Attenuation:

Public Member Functions
	WsfEM_ITU_Attenuation (const UtAtmosphere &aAtm)
	WsfEM_ITU_Attenuation (const WsfEM_ITU_Attenuation &aSrc)
WsfEM_ITU_Attenuation &	operator= (const WsfEM_ITU_Attenuation &aRhs)=delete
WsfEM_Attenuation *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
bool	AcceptsInlineBlockInput () const override
double	ComputeAttenuationFactor (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment, WsfEM_Interaction::Geometry aGeometry) override
double	ComputeAttenuationFactor (double aRange, double aElevation, double aAltitude, double aFrequency, WsfEM_Types::Polarization aPolarization, double aEarthRadiusMultiplier, WsfEnvironment &aEnvironment)
Public Member Functions inherited from WsfEM_Attenuation
	WsfEM_Attenuation ()
	~WsfEM_Attenuation () override
virtual bool	Initialize (WsfEM_XmtrRcvr *aXmtrRcvrPtr)
virtual bool	Initialize (WsfEM_Xmtr *aXmtrPtr)
const char *	GetScriptClassName () const 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 std::function< WsfEM_Attenuation *(const std::string &)>	GetObjectFactory (WsfScenario &aScenario)
static double	ComputeGasSpecificAttenuation (double aFrequency, double aPressure, double aTemperature, double aWaterVaporDensity)
static double	ComputeCloudSpecificAttenuation (double aFrequency, double aTemperature, double aWaterDensity)
static double	ComputeRainSpecificAttenuation (double aFrequency, WsfEM_Types::Polarization aPolarization, double aRainRate)
static void	PlotGasFigure1 ()
static void	PlotGasFigure2 ()
static void	PlotGasFigure3 ()
static void	PlotCloudFigure1 ()

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Member Functions inherited from WsfEM_Attenuation
	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 inherited from WsfEM_Attenuation
bool	mDebugEnabled
bool	mSortEndPoints

Detailed Description

An atmospheric attenuation model based on standards from the International Telecommunications Union (ITU) Radio Communication Sector.

The following ITU recommendations are used in this model.

1) "Recommendation ITU-R P.676-9, Attenuation by atmospheric gases". 2) "Recommendation ITU-R P.835-4, Reference standard atmospheres". 3) "Recommendation ITU-R P.838-3, Specific attenuation model for rain for use in prediction methods". 4) "Recommendation ITU-R P.840-4, Attenuation due to clouds and fog".

Constructor & Destructor Documentation

WsfEM_ITU_Attenuation() [1/2]

WsfEM_ITU_Attenuation::WsfEM_ITU_Attenuation

(

const UtAtmosphere &

aAtm

)

References WsfEM_Attenuation::WsfEM_Attenuation().

Referenced by Clone(), operator=(), and WsfEM_ITU_Attenuation().

WsfEM_ITU_Attenuation() [2/2]

WsfEM_ITU_Attenuation::WsfEM_ITU_Attenuation

(

const WsfEM_ITU_Attenuation &

aSrc

)

References WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_ITU_Attenuation().

Member Function Documentation

AcceptsInlineBlockInput()

bool WsfEM_ITU_Attenuation::AcceptsInlineBlockInput ( ) const

inlineoverridevirtual

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 from WsfEM_Attenuation.

Clone()

WsfEM_Attenuation * WsfEM_ITU_Attenuation::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_Attenuation.

References WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_ITU_Attenuation().

ComputeAttenuationFactor() [1/2]

double WsfEM_ITU_Attenuation::ComputeAttenuationFactor	(	double	aRange,
		double	aElevation,
		double	aAltitude,
		double	aFrequency,
		WsfEM_Types::Polarization	aPolarization,
		double	aEarthRadiusMultiplier,
		WsfEnvironment &	aEnvironment )

ComputeAttenuationFactor() [2/2]

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

overridevirtual

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 from WsfEM_Attenuation.

References ComputeAttenuationFactor(), WsfEM_XmtrRcvr::GetEarthRadiusMultiplier(), WsfEM_XmtrRcvr::GetFrequency(), WsfEM_XmtrRcvr::GetPolarization(), WsfEM_Attenuation::GetRangeElevationAltitude(), and WsfEM_Interaction::GetTransmitter().

Referenced by ComputeAttenuationFactor(), and ProcessInput().

ComputeCloudSpecificAttenuation()

double WsfEM_ITU_Attenuation::ComputeCloudSpecificAttenuation ( double aFrequency, double aTemperature, double aWaterDensity )

static

Referenced by PlotCloudFigure1().

ComputeGasSpecificAttenuation()

double WsfEM_ITU_Attenuation::ComputeGasSpecificAttenuation ( double aFrequency, double aPressure, double aTemperature, double aWaterVaporDensity )

static

Compute the specific attenuation according to ITU-R P.676 for a given set of conditions.

Parameters

aFrequency	The frequency (Hz)
aPressure	The dry air pressure in (N/m^2 (i.e.: Pa)
aTemperature	The temperature (deg K)
aWaterVaporDensity	The water vapor density (kg/m^3)

Returns

The specific attenuation (dB/km).

References gamma.

Referenced by PlotGasFigure1(), PlotGasFigure2(), and PlotGasFigure3().

ComputeRainSpecificAttenuation()

double WsfEM_ITU_Attenuation::ComputeRainSpecificAttenuation ( double aFrequency, WsfEM_Types::Polarization aPolarization, double aRainRate )

static

References WsfEM_Types::cPOL_VERTICAL.

GetObjectFactory()

std::function< WsfEM_Attenuation *(const std::string &)> WsfEM_ITU_Attenuation::GetObjectFactory ( WsfScenario & aScenario )

static

References GetObjectFactory(), and WsfEM_Attenuation::WsfEM_Attenuation().

Referenced by GetObjectFactory(), operator=(), and WsfEM_AttenuationTypes::WsfEM_AttenuationTypes().

operator=()

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

delete

References GetObjectFactory(), WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_ITU_Attenuation().

PlotCloudFigure1()

void WsfEM_ITU_Attenuation::PlotCloudFigure1 ( )

static

Generate a GNUPLOT data and command file for Figure 1 from ITU-R P.840. The output files are cloud_figure_1.plt (the data) and cloud_figure_1.gnu (the GNUPLOT command file).

References ComputeCloudSpecificAttenuation().

Referenced by ProcessInput().

PlotGasFigure1()

void WsfEM_ITU_Attenuation::PlotGasFigure1 ( )

static

Generate a GNUPLOT data and command file for Figure 1 from ITU-R P.676 The output files are gas_figure_1.plt (the data) and gas_figure_1.gnu (the GNUPLOT command file).

References ComputeGasSpecificAttenuation().

Referenced by ProcessInput().

PlotGasFigure2()

void WsfEM_ITU_Attenuation::PlotGasFigure2 ( )

static

Generate a GNUPLOT data and command file for Figure 2 from ITU-R P.676 The output files are gas_figure_2.plt (the data) and gas_figure_2.gnu (the GNUPLOT command file).

References ComputeGasSpecificAttenuation().

Referenced by ProcessInput().

PlotGasFigure3()

void WsfEM_ITU_Attenuation::PlotGasFigure3 ( )

static

Generate a GNUPLOT data and command file for Figure 3 from ITU-R P.676 The output files are gas_figure_3.plt (the data) and gas_figure_3.gnu (the GNUPLOT command file).

References ComputeGasSpecificAttenuation().

Referenced by ProcessInput().

ProcessInput()

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

References ComputeAttenuationFactor(), WsfEM_Types::cPOL_VERTICAL, WsfEM_Util::EnumToString(), WsfScenario::FromInput(), PlotCloudFigure1(), PlotGasFigure1(), PlotGasFigure2(), PlotGasFigure3(), WsfEM_Attenuation::ProcessInput(), and WsfEM_Util::StringToEnum().

---

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

• WsfEM_ITU_Attenuation.hpp
• WsfEM_ITU_Attenuation.cpp