WsfFieldOfView.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2016 Infoscitex, a DCS 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 WSFFIELDOFVIEW_HPP
#define WSFFIELDOFVIEW_HPP
 
#include "wsf_export.h"
 
class UtInput;
#include "UtScriptAccessible.hpp"
class WsfArticulatedPart;
class WsfPlatform;
class WsfEM_Antenna;
class WsfScenario;
#include "WsfStringId.hpp"

class WSF_EXPORT WsfFieldOfView : public UtScriptAccessible
{
public:
   virtual bool ProcessInput(UtInput& aInput);
   virtual bool Initialize(const WsfArticulatedPart& aArticulatedPart);
   const char*  GetScriptClassName() const override { return "WsfFieldOfView"; }

   virtual WsfFieldOfView* Clone() const = 0;



   virtual bool WithinFieldOfView(double aThisToTgtAz, double aThisToTgtEl) = 0;
 
   virtual bool WithinFieldOfView(WsfArticulatedPart* aArticulatedPart,
                                  double              aTgtLocWCS[3],
                                  double              aEarthRadiusMultiplier,
                                  double&             aTrueThisToTgtAz,
                                  double&             aTrueThisToTgtEl,
                                  double              aApparentThisToTgtLocWCS[3],
                                  double&             aApparentThisToTgtAz,
                                  double&             aApparentThisToTgtEl,
                                  double              aApparentTgtToThisLocWCS[3]);
 
   virtual bool WithinFieldOfView(WsfEM_Antenna* aAntennaPtr,
                                  double         aTgtLocWCS[3],
                                  double         aEarthRadiusMultiplier,
                                  double&        aTrueThisToTgtAz,
                                  double&        aTrueThisToTgtEl,
                                  double         aApparentThisToTgtLocWCS[3],
                                  double&        aApparentThisToTgtAz,
                                  double&        aApparentThisToTgtEl,
                                  double         aApparentTgtToThisLocWCS[3]);

   virtual bool GetAzimuthFieldOfView(double& aMinAzFOV, double& aMaxAzFOV) const { return false; }

   virtual bool GetElevationFieldOfView(double& aMinElFOV, double& aMaxElFOV) const { return false; }

   virtual bool SetAzimuthFieldOfView(double aMinAzFOV, double aMaxAzFOV) { return false; }

   virtual bool SetElevationFieldOfView(double aMinElFOV, double aMaxElFOV) { return false; }

   const WsfStringId& GetType() const { return mType; }
 
protected:
   void SetType(const WsfStringId& aType) { mType = aType; }
 
   const WsfArticulatedPart* GetArticulatedPart() const { return mArticulatedPartPtr; }
 
private:
   WsfStringId               mType;
   const WsfArticulatedPart* mArticulatedPartPtr = nullptr;
};
 
#endif