MapPlotVariable.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2019 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 MAPPLOTVARIABLE_HPP
#define MAPPLOTVARIABLE_HPP
 
class WsfSensor;
class WsfSensorResult;
class WsfSimulation;
class UtInput;
class MapPlotVariables;

class MapPlotVariable
{
public:
   MapPlotVariable(double aInitValue)
      : mInitValue(aInitValue)
   {
   }
   virtual ~MapPlotVariable() = default;
 
   class SharedData
   {
   public:
      void SetCrossRange(double aCrossRange) { mCrossRange = aCrossRange; }

      void SetDownRange(double aDownRange) { mDownRange = aDownRange; }

      void SetRangeScale(double aRangeScale) { mRangeScale = aRangeScale; }

      double GetCrossRange() const { return mCrossRange; }

      double GetDownRange() const { return mDownRange; }

      double GetRangeScale() const { return mRangeScale; }
 
   private:
      double mCrossRange{0.0};
      double mDownRange{0.0};
      double mRangeScale{1.0};
   };

   double GetInitialValue() const { return mInitValue; };

   virtual bool ProcessInput(UtInput& aInput) { return false; }

   virtual bool Initialize(WsfSimulation& aSimulation, const SharedData& aSharedData)
   {
      mSharedDataPtr = &aSharedData;
      return true;
   }

   virtual double Evaluate(double           aSimTime,
                           WsfSimulation*   aSimulationPtr,
                           double           aValue,
                           WsfSensor*       aSensorPtr,
                           WsfSensorResult& aResult) const = 0;
 
protected:
   const SharedData* mSharedDataPtr{nullptr};
 
private:
   const double mInitValue{0.0};
};
 
#endif