WsfRadarSignature.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 WSFRADARSIGNATURE_HPP
#define WSFRADARSIGNATURE_HPP
 
#include "wsf_export.h"
 
class UtScriptTypes;
#include "WsfEM_Types.hpp"
class WsfEM_Rcvr;
class WsfEM_Xmtr;
class WsfPlatform;
class WsfScenario;
#include "WsfSignature.hpp"

class WSF_EXPORT WsfRadarSignature : public WsfSignature
{
public:
   enum
   {
      cSIGNATURE_INDEX = 0 
   };
 
   WsfRadarSignature();
   WsfRadarSignature* Clone() const override = 0;
 
   // =================================================================================================
   virtual float GetSignature(WsfStringId               aStateId,
                              WsfEM_Types::Polarization aPolarization,
                              double                    aFrequency,
                              double                    aTgtToXmtrAz,
                              double                    aTgtToXmtrEl,
                              double                    aTgtToRcvrAz,
                              double                    aTgtToRcvrEl,
                              WsfEM_Xmtr*               aXmtrPtr = nullptr,
                              WsfEM_Rcvr*               aRcvrPtr = nullptr) = 0;

   virtual std::pair<float, float> GetSignatureLimits(WsfStringId aStateId, WsfEM_Types::Polarization aPolarization) const;


   static WsfStringId GetInputType(WsfPlatform* aPlatformPtr);
 
   static WsfStringId GetState(WsfPlatform* aPlatformPtr);
 
   static bool SetState(WsfPlatform* aPlatformPtr, WsfStringId aState);
 
   static float GetScaleFactor(WsfPlatform* aPlatformPtr);
 
   static bool SetScaleFactor(WsfPlatform* aPlatformPtr, float aScaleFactor);
 
   static float GetValue(WsfPlatform*              aPlatformPtr,
                         WsfEM_Types::Polarization aPolarization,
                         double                    aFrequency,
                         double                    aTgtToXmtrAz,
                         double                    aTgtToXmtrEl,
                         double                    aTgtToRcvrAz,
                         double                    aTgtToRcvrEl);
 
   static float GetValue(WsfPlatform* aPlatformPtr,
                         WsfEM_Xmtr*  aXmtrPtr,
                         WsfEM_Rcvr*  aRcvrPtr,
                         double       aTgtToXmtrAz,
                         double       aTgtToXmtrEl,
                         double       aTgtToRcvrAz,
                         double       aTgtToRcvrEl);
 
   static WsfRadarSignature* GetSignature(WsfPlatform* aPlatformPtr);
 
   static bool SetSignature(WsfPlatform* aPlatformPtr, WsfRadarSignature* aSignaturePtr);
 
   static void RegisterScriptMethods(UtScriptTypes& aScriptTypes);
   static void RegisterInterface(WsfScenario& aScenario);
};
 
#endif