WsfOpticalSignature.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 WSFOPTICALSIGNATURE_HPP
#define WSFOPTICALSIGNATURE_HPP
 
#include "wsf_mil_export.h"
 
#include <vector>
 
class UtScriptTypes;
#include "WsfEM_Types.hpp"
class WsfPlatform;
class WsfScenario;
#include "WsfSignature.hpp"

class WSF_MIL_EXPORT WsfOpticalSignature : public WsfSignature
{
public:
   enum
   {
      cSIGNATURE_INDEX = 1 
   };
 
   WsfOpticalSignature();
   WsfOpticalSignature* Clone() const override = 0;

   virtual float GetSignature(double aSimTime, WsfStringId aStateId, double aAzimuth, double aElevation) = 0;


   virtual bool
   GetProjectedArea(double aSimTime, WsfStringId aStateId, double aAzimuth, double aElevation, double& aProjectedArea);
 
   using BandList = std::vector<WsfEM_Types::OpticalBand>;
 
   virtual bool GetRadiantIntensity(double          aSimTime,
                                    WsfStringId     aState,
                                    const BandList& aBands,
                                    double          aAzimuth,
                                    double          aElevation,
                                    double&         aRadiantIntensity);
 
   bool UsesInherentContrast() const { return mUsesInherentContrast; }


   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(double aSimTime, WsfPlatform* aPlatformPtr, double aAzimuth, double aElevation);
 
   static bool GetProjectedArea(double       aSimTime,
                                WsfPlatform* aPlatformPtr,
                                double       aAzimuth,
                                double       aElevation,
                                double&      aProjectedArea);
 
   static bool GetRadiantIntensity(double          aSimTime,
                                   WsfPlatform*    aPlatformPtr,
                                   const BandList& aBands,
                                   double          aAzimuth,
                                   double          aElevation,
                                   double&         aRadiantIntensity);
 
   static bool UsesInherentContrast(WsfPlatform* aPlatformPtr);
 
   static void RegisterScriptMethods(UtScriptTypes& aScriptTypes);
   static void RegisterInterface(WsfScenario& aScenario);
 
protected:
   void SetInherentContrast(bool aContrast) { mUsesInherentContrast = aContrast; }
 
private:
   bool mUsesInherentContrast = true;
};
 
#endif