A trivial attenuation model that is uses a fixed dB/length. More...
#include <WsfEM_SimpleAttenuation.hpp>
Public Member Functions | |
| WsfEM_SimpleAttenuation () | |
| WsfEM_SimpleAttenuation (const WsfEM_SimpleAttenuation &aSrc) | |
| WsfEM_SimpleAttenuation & | operator= (const WsfEM_SimpleAttenuation &aRhs)=delete |
| WsfEM_Attenuation * | Clone () const override |
| ~WsfEM_SimpleAttenuation () override=default | |
| bool | ProcessInput (UtInput &aInput) override |
| bool | AcceptsInlineBlockInput () const override |
| 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 |
| 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) |
Static Public Member Functions | |
| static WsfEM_Attenuation * | ObjectFactory (const std::string &aTypeName) |
| Factory method called by WsfEM_AttenuationTypes. | |
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) | |
| 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
A trivial attenuation model that is uses a fixed dB/length.
Constructor & Destructor Documentation
◆ WsfEM_SimpleAttenuation() [1/2]
| WsfEM_SimpleAttenuation::WsfEM_SimpleAttenuation | ( | ) |
References WsfEM_Attenuation::WsfEM_Attenuation().
Referenced by Clone(), ObjectFactory(), operator=(), and WsfEM_SimpleAttenuation().
◆ WsfEM_SimpleAttenuation() [2/2]
| WsfEM_SimpleAttenuation::WsfEM_SimpleAttenuation | ( | const WsfEM_SimpleAttenuation & | aSrc | ) |
References WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_SimpleAttenuation().
◆ ~WsfEM_SimpleAttenuation()
|
overridedefault |
References ObjectFactory(), and WsfEM_Attenuation::WsfEM_Attenuation().
Member Function Documentation
◆ AcceptsInlineBlockInput()
|
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()
|
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_SimpleAttenuation().
◆ ObjectFactory()
|
static |
Factory method called by WsfEM_AttenuationTypes.
References WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_SimpleAttenuation().
Referenced by WsfEM_AttenuationTypes::WsfEM_AttenuationTypes(), and ~WsfEM_SimpleAttenuation().
◆ operator=()
|
delete |
References WsfEM_Attenuation::WsfEM_Attenuation(), and WsfEM_SimpleAttenuation().
◆ ProcessInput()
|
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: