WsfEM_Propagation Class Reference

An abstract base class for computing pattern propagation factors. More...

#include <WsfEM_Propagation.hpp>

Inheritance diagram for WsfEM_Propagation:

Collaboration diagram for WsfEM_Propagation:

Public Member Functions
	WsfEM_Propagation ()
	Constructor.
	~WsfEM_Propagation () override=default
WsfEM_Propagation *	Clone () const override=0
const char *	GetScriptClassName () const override
bool	DebugEnabled () const
	Is 'debug' enabled?
virtual double	ComputePropagationFactor (WsfEM_Interaction &aInteraction, WsfEnvironment &aEnvironment)=0
virtual bool	Initialize (WsfEM_XmtrRcvr *aXmtrRcvrPtr)
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)

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

Protected Attributes
bool	mDebugEnabled

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

Detailed Description

An abstract base class for computing pattern propagation factors.

Constructor & Destructor Documentation

WsfEM_Propagation() [1/2]

WsfEM_Propagation::WsfEM_Propagation

(

)

Constructor.

References mDebugEnabled, and WsfObject::WsfObject().

Referenced by WsfEM_ALARM_Propagation::Clone(), WsfEM_FastMultipath::Clone(), WsfEM_GroundWavePropagation::Clone(), Clone(), WsfEM_ALARM_Propagation::ObjectFactory(), WsfEM_FastMultipath::ObjectFactory(), WsfEM_GroundWavePropagation::ObjectFactory(), WsfEM_FastMultipath::operator=(), WsfEM_GroundWavePropagation::operator=(), WsfEM_ALARM_Propagation::WsfEM_ALARM_Propagation(), WsfEM_ALARM_Propagation::WsfEM_ALARM_Propagation(), WsfEM_Propagation(), and WsfEM_ALARM_Propagation::~WsfEM_ALARM_Propagation().

~WsfEM_Propagation()

WsfEM_Propagation::~WsfEM_Propagation ( )

overridedefault

WsfEM_Propagation() [2/2]

WsfEM_Propagation::WsfEM_Propagation ( const WsfEM_Propagation & aSrc )

protected

Copy constructor.

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

Member Function Documentation

Clone()

WsfEM_Propagation * WsfEM_Propagation::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_ALARM_Propagation, WsfEM_FastMultipath, and WsfEM_GroundWavePropagation.

References WsfEM_Propagation().

ComputePropagationFactor()

virtual double WsfEM_Propagation::ComputePropagationFactor ( WsfEM_Interaction & aInteraction, WsfEnvironment & aEnvironment )

pure virtual

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).

Implemented in WsfEM_ALARM_Propagation, WsfEM_FastMultipath, and WsfEM_GroundWavePropagation.

References Initialize().

DebugEnabled()

bool WsfEM_Propagation::DebugEnabled ( ) const

inline

Is 'debug' enabled?

References mDebugEnabled.

Referenced by WsfEM_ALARM_Propagation::ComputePropagationFactor().

GetScriptClassName()

const char * WsfEM_Propagation::GetScriptClassName ( ) const

inlineoverride

Initialize() [1/2]

bool WsfEM_Propagation::Initialize ( WsfEM_Xmtr * aXmtrPtr )

virtual

Initialize the propagation object.

Parameters

aXmtrPtr

The transmitter to which the propagation 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_Propagation::Initialize ( WsfEM_XmtrRcvr * aXmtrRcvrPtr )

virtual

Initialize the propagation object.

Parameters

aXmtrRcvrPtr

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

Reimplemented in WsfEM_ALARM_Propagation.

Referenced by ComputePropagationFactor(), WsfEM_ALARM_Propagation::Initialize(), and Initialize().

IsNullModel()

virtual bool WsfEM_Propagation::IsNullModel ( ) const

inlinevirtual

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

Note

See the code in WsfEM_PropagationTypes as to why this is present.

ProcessInput()

bool WsfEM_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 mDebugEnabled, and WsfObject::ProcessInput().

Referenced by WsfEM_ALARM_Propagation::ProcessInput(), WsfEM_FastMultipath::ProcessInput(), and WsfEM_GroundWavePropagation::ProcessInput().

Member Data Documentation

mDebugEnabled

bool WsfEM_Propagation::mDebugEnabled

protected

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

---

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

• WsfEM_Propagation.hpp
• WsfEM_Propagation.cpp