An attenuation model for optical systems (visual and infrared). More...

#include <WsfOpticalAttenuation.hpp>

Inheritance diagram for WsfOpticalAttenuation:

[legend]

Collaboration diagram for WsfOpticalAttenuation:

[legend]

Classes
class	Segment
class	SegmentRef
class	Table
class	TableX
class	TableRef

Public Member Functions
	WsfOpticalAttenuation (const WsfScenario &aScenario)
	WsfOpticalAttenuation (const WsfScenario &aScenario, double aAtmosphericAttenuation, UtAtmosphere::AtmosphereType aAtmosphereType)
	Create an instance that behaves like the old embedded model in WsfEOIR_Sensor and WsfIRST_Sensor.
	~WsfOpticalAttenuation () override=default
WsfEM_Attenuation *	Clone () const override
bool	Initialize (WsfEM_XmtrRcvr *aXmtrRcvrPtr) override
bool	ProcessInput (UtInput &aInput) override
double	ComputeAttenuationFactor (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment, WsfEM_Interaction::Geometry aGeometry) override
Public Member Functions inherited from WsfEM_Attenuation
	WsfEM_Attenuation ()
	~WsfEM_Attenuation () override
virtual bool	Initialize (WsfEM_Xmtr *aXmtrPtr)
const char *	GetScriptClassName () const override
bool	DebugEnabled () const
	Is 'debug' enabled?
virtual bool	IsNullModel () const
virtual bool	AcceptsInlineBlockInput () 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)

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 attenuation model for optical systems (visual and infrared).

Constructor & Destructor Documentation

◆ WsfOpticalAttenuation() [1/2]

WsfOpticalAttenuation::WsfOpticalAttenuation ( const WsfScenario & aScenario )

References WsfEM_Attenuation::WsfEM_Attenuation().

Referenced by Clone().

◆ WsfOpticalAttenuation() [2/2]

WsfOpticalAttenuation::WsfOpticalAttenuation	(	const WsfScenario &	aScenario,
		double	aAtmosphericAttenuation,
		UtAtmosphere::AtmosphereType	aAtmosphereType )

Create an instance that behaves like the old embedded model in WsfEOIR_Sensor and WsfIRST_Sensor.

References WsfEM_Attenuation::WsfEM_Attenuation().

◆ ~WsfOpticalAttenuation()

WsfOpticalAttenuation::~WsfOpticalAttenuation ( )

overridedefault

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

Member Function Documentation

◆ Clone()

WsfEM_Attenuation * WsfOpticalAttenuation::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 WsfOpticalAttenuation().

◆ ComputeAttenuationFactor()

double WsfOpticalAttenuation::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 WsfEM_Attenuation::GetAltitudesAndGroundRange(), WsfEM_Attenuation::GetRangeElevationAltitude(), and WsfEM_Interaction::mEarthRadiusScale.

◆ GetObjectFactory()

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

static

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

Referenced by WsfMilExtension::AddedToScenario(), GetObjectFactory(), and ~WsfOpticalAttenuation().

◆ Initialize()

bool WsfOpticalAttenuation::Initialize ( WsfEM_XmtrRcvr * aXmtrRcvrPtr )

overridevirtual

Initialize the attenuation object.

Parameters

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

Reimplemented from WsfEM_Attenuation.

References WsfEM_Attenuation::Initialize(), and ok.

◆ ProcessInput()

bool WsfOpticalAttenuation::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 WsfEM_Attenuation::ProcessInput().

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

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfOpticalAttenuation() [1/2]

◆ WsfOpticalAttenuation() [2/2]

◆ ~WsfOpticalAttenuation()

Member Function Documentation

◆ Clone()

◆ ComputeAttenuationFactor()

◆ GetObjectFactory()

◆ Initialize()

◆ ProcessInput()