WsfStandardAntennaPattern.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 WSFSTANDARDANTENNAPATTERN_HPP
#define WSFSTANDARDANTENNAPATTERN_HPP
 
#include "wsf_export.h"
 
#include <memory>
 
class UtAzElTable;
#include "WsfAntennaPattern.hpp"

 
class WSF_EXPORT WsfStandardAntennaPattern : public WsfAntennaPattern
{
public:
   enum PatternType
   {
      cUNKNOWN,
      cTABLE,
      cCIRCULAR_PATTERN,
      cCOSECANT_SQUARED_PATTERN,
      cSINE_PATTERN,
      cUNIFORM_PATTERN
   };
 
   class StandardData : public WsfAntennaPattern::BaseData
   {
   public:
      StandardData();
      ~StandardData() override;
 
      bool ProcessInput(WsfAntennaPattern& aPattern, UtInput& aInput) override;
      bool Initialize(WsfAntennaPattern& aAntennaPattern) override;
 
      double GetGain(double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El) override;
 
      void ResetPatternType();
 
      static double BesselJ1(double aX);
 
      PatternType  mPatternType;
      UtAzElTable* mTablePtr;
 
      double mPeakGain;
      double mInputAzBeamwidth;
      double mInputElBeamwidth;
      double mAzBeamwidth;
      double mElBeamwidth;


      double mSineAngleModificationFactor;
      int    mSineFunctionType;


      double mCscMinElForPeakGain;
      double mCscElOfPeakCsc2Boundary;
      double mCscMaxElForCsc2;


      double mCscMinimumGainAdjusted;
      double mCscPeakGainAdjusted;
      double mCscK_Az;
      double mCscK_El;
      double mCscWithinCsc2Factor;
      double mCscAboveCsc2Factor;
 
      bool mFirstTime;
 
 
   protected:
      static double CircularPattern(double aAzimuth, double aElevation, double aPeakGain, double aBeamwidth);
 
      double CosecantSquaredPattern(double aAzimuth, double aElevation);
 
      static double SinePattern(double aAzimuth,
                                double aElevation,
                                double aPeakGain,
                                double aAzimuthBeamwidth,
                                double aElevationBeamwidth,
                                double aOffset,
                                double aFact,
                                int    aType);
 
      void ProcessCircularInput(WsfAntennaPattern& aPattern, UtInput& aInput);
      void ProcessCosecantSquaredInput(WsfAntennaPattern& aPattern, UtInput& aInput);
      void ProcessPatternTableInput(WsfAntennaPattern& aPattern, UtInput& aInput);
      void ProcessSineInput(WsfAntennaPattern& aPattern, UtInput& aInput);
      void ProcessUniformInput(WsfAntennaPattern& aPattern, UtInput& aInput);
   };
 
   WsfStandardAntennaPattern();
   WsfStandardAntennaPattern& operator=(const WsfStandardAntennaPattern& aRhs) = delete;
   ~WsfStandardAntennaPattern() override;
 
   WsfAntennaPattern* Clone() const override;
 
   double GetGain(double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El) override;
 
   double GetAzimuthBeamwidth(double aFrequency, double aEBS_Azimuth, double aEBS_Elevation) const override;
   double GetElevationBeamwidth(double aFrequency, double aEBS_Azimuth, double aEBS_Elevation) const override;
   double GetPeakGain(double aFrequency) const override;


   double         GetSineAngleModificationFactor() const { return GetStandardData()->mSineAngleModificationFactor; }
   int            GetSineFunctionType() const { return GetStandardData()->mSineFunctionType; }
   int            GetStandardPatternType() const { return GetStandardData()->mPatternType; }
   UtAzElTable*   GetUtAzElTable() const { return GetStandardData()->mTablePtr; }
   double         GetCscMinElForPeakGain() const { return GetStandardData()->mCscMinElForPeakGain; }
   double         GetCscElOfPeakCsc2Boundary() const { return GetStandardData()->mCscElOfPeakCsc2Boundary; }
   double         GetCscMaxElForCsc2() const { return GetStandardData()->mCscMaxElForCsc2; }
   virtual double GetInputAzimuthBeamwidth() const { return GetStandardData()->mInputAzBeamwidth; }
   virtual double GetInputElevationBeamwidth() const { return GetStandardData()->mInputElBeamwidth; }
   StandardData*  GetStandardData() const { return static_cast<StandardData*>(mSharedDataPtr); }
 
protected:
   WsfStandardAntennaPattern(const WsfStandardAntennaPattern& aSrc);
 
private:
   // StandardData* mStandardDataPtr;
};
 
#endif