WsfEM_Attenuation.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFEM_ATTENUATION_HPP
#define WSFEM_ATTENUATION_HPP
 
#include "wsf_export.h"
 
class UtInput;
#include "WsfEM_Interaction.hpp"
class WsfEM_Xmtr;
class WsfEM_XmtrRcvr;
class WsfEnvironment;
#include "WsfObject.hpp"
class WsfScenario;

class WSF_EXPORT WsfEM_Attenuation : public WsfObject
{
public:
   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 { return "WsfEM_Attenuation"; }

   bool DebugEnabled() const { return mDebugEnabled; }

   virtual bool IsNullModel() const { return false; }

   virtual bool AcceptsInlineBlockInput() const { return false; }
 
   virtual double ComputeAttenuationFactor(WsfEM_Interaction&          aInteraction,
                                           WsfEnvironment&             aEnvironment,
                                           WsfEM_Interaction::Geometry aGeometry);
 
protected:
   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);
 
   bool mDebugEnabled;

   bool mSortEndPoints;
 
private:
   WsfEM_Attenuation& operator=(const WsfEM_Attenuation& aRhs) = delete;
 
   double GetGroundRange(const double aLocWCS_1[3], const double aLocWCS_2[3]) const;
 
   void GetRangeElevationAltitude(WsfPlatform*                           aSrcPlatformPtr,
                                  WsfPlatform*                           aTgtPlatformPtr,
                                  const WsfEM_Interaction::LocationData& aSrcLoc,
                                  const WsfEM_Interaction::LocationData& aTgtLoc,
                                  const WsfEM_Interaction::RelativeData& aSrcToTgt,
                                  const WsfEM_Interaction::RelativeData& aTgtToSrc,
                                  double&                                aRange,
                                  double&                                aElevation,
                                  double&                                aAltitude);
 
   static WsfEM_Attenuation* CreateInstance(const std::string& aTypeName);
};
 
#endif