troposphereStateComponent.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2023 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfStateData/stateComponent.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <vrfStateData/stateComponentImplementationTemplate.h>
#include <vrfutil/rwWindLevels.h>
#include <tbb/spin_rw_mutex.h>

namespace makVrf
{

   struct DT_DLL_vrfStateData DtTroposphereStateComponentData
   {
      DtTroposphereStateComponentData()
         : myWindLevels()
         , myPriority(0)
      {};

      DtTroposphereStateComponentData(const DtTroposphereStateComponentData& orig)
      {
         *this = orig;
      };

      DtTroposphereStateComponentData& operator=(const DtTroposphereStateComponentData& orig)
      {
         {
            myWindLevels = orig.myWindLevels;
            myPriority = orig.myPriority;
         }
         return *this;
      };

      ACCESSOR_MUTATOR_MEMBER(DtRwWindLevels, windLevels, WindLevels);
      ACCESSOR_MUTATOR_MEMBER(int, priority, Priority);
   };

   class DT_DLL_vrfStateData DtTroposphereStateComponent : public DtFrameStateInterface
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::TroposphereStateComponent)

         DtTroposphereStateComponent(DtStateData* storage)
         : DtFrameStateInterface(storage)
      {
      }


      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtRwWindLevels, windLevels, WindLevels);
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(int, priority, Priority);


      virtual const double visibility(double atAlt = 0.) const { throw DtUnimplementedMethod("visibility(atAltidude) is not implemented by this class."); };
      virtual void setVisibility(const double&) { throw DtUnimplementedMethod("setVisibility(double) is not implemented by this class."); };
      virtual void setVisibility(const double& atAlt, const double&) { throw DtUnimplementedMethod("setVisibility(const double& atAlt, const double& vis) is not implemented by this class."); };

      virtual const double windSpeed(double atAlt = 0.) const { throw DtUnimplementedMethod("windSpeed(atAltidude) is not implemented by this class."); };
      virtual void setWindSpeed(const double&) { throw DtUnimplementedMethod("setWindSpeed(double) is not implemented by this class."); };
      virtual void setWindSpeed(const double& atAlt, const double&) { throw DtUnimplementedMethod("setWindSpeed(const double& atAlt, const double& vis) is not implemented by this class."); };

      virtual const double windDirection(double atAlt = 0.) const { throw DtUnimplementedMethod("windDirection(atAltidude) is not implemented by this class."); };
      virtual void setWindDirection(const double&) { throw DtUnimplementedMethod("setWindDirection(double) is not implemented by this class."); };
      virtual void setWindDirection(const double& atAlt, const double&) { throw DtUnimplementedMethod("setWindDirection(const double& atAlt, const double& vis) is not implemented by this class."); };

      virtual const int obscurant(double atAlt = 0.) const { throw DtUnimplementedMethod("obscurant(atAltidude) is not implemented by this class."); };
      virtual void setObscurant(double atAlt, const int&) { throw DtUnimplementedMethod("setObscurant(double, int) is not implemented by this class."); };

      virtual void addWindLevel(double altitude, double windSpeed, double windDirection,
         double visibleDistance, int obscurant, int cloudType, double cloudDensity, double skyCoverage) {
         throw DtUnimplementedMethod("addWindLevel is not implemented by this class.");
      };
      virtual void clearWindLevels() { throw DtUnimplementedMethod("clearWindLevels is not implemented by this class."); };

      virtual void removeWindLevel(double baseAltitude) { throw DtUnimplementedMethod("removeWindLevel is not implemented by this class."); };

      virtual bool windSpeedAndDirectionAtAltitude(double altMSL, double& windSpeed, double& windDirection) const { throw DtUnimplementedMethod("windSpeedAndDirectionAtAltitude is not implemented by this class."); };
      virtual void setWindSpeedAndDirectionAtAltitude(const double& altMSL, const double& windSpeed, const double& windDirection) { throw DtUnimplementedMethod("setWindSpeedAndDirectionAtAltitude is not implemented by this class."); };

      virtual bool visibilityAndObscurantAtAltitude(double altMSL, double& distance, int& obs) const { throw DtUnimplementedMethod("visibilityAndObscurantAtAltitude is not implemented by this class."); };
      virtual void setVisibilityAndObscurantAtAltitude(const double& altMSL, const double& distance, const int& obs) { throw DtUnimplementedMethod("setVisibilityAndObscurantAtAltitude is not implemented by this class."); };

      void setIsRemoteComponent(bool b) { myIsRemoteComponent = b; };

   protected:
      bool myIsRemoteComponent = false;
   };

   class DT_DLL_vrfStateData DtTroposphereStateComponentNextFrame : public DtStateComponentNextFrameTemplate< DtTroposphereStateComponent, DtTroposphereStateComponentData >
   {
   public:
      DtTroposphereStateComponentNextFrame(DtStateData* sd)
         : DtStateComponentNextFrameTemplate(sd)
      {
      };

      virtual ~DtTroposphereStateComponentNextFrame() override {};

      virtual const DtRwWindLevels& windLevels() const override;
      virtual void setWindLevels(const DtRwWindLevels&) override;

      virtual void setPriority(const int&) override;
      virtual const int priority() const override;

      virtual const double windSpeed(double atAlt = 0.) const override;
      virtual void setWindSpeed(const double&) override;
      virtual void setWindSpeed(const double& atAlt, const double&) override;

      virtual const double windDirection(double atAlt = 0.) const override;
      virtual void setWindDirection(const double&) override;
      virtual void setWindDirection(const double& atAlt, const double&) override;

      virtual const int obscurant(double atAltitude) const override;
      virtual void setObscurant(double baseAlt, const int&) override;
      virtual const double visibility(double atAltitude) const override;
      virtual void setVisibility(const double&) override;
      virtual void setVisibility(const double&, const double&) override;

      std::shared_ptr<tbb::spin_rw_mutex::scoped_lock> readLock();
      std::shared_ptr<tbb::spin_rw_mutex::scoped_lock> writeLock();


      virtual void addWindLevel(double altitude, double windSpeed, double windDirection, double visibleDistance,
         int obscurant, int cloudType, double cloudDensity, double skyCoverage) override;
      virtual void clearWindLevels() override;

      virtual void removeWindLevel(double baseAltitude) override;

      virtual bool windSpeedAndDirectionAtAltitude(
         double altMSL, double& windSpeed, double& windDirection) const override;
      virtual void setWindSpeedAndDirectionAtAltitude(const double& altMSL, const double& windSpeed, const double& windDirection) override;

      virtual bool visibilityAndObscurantAtAltitude(double altMSL, double& distance, int& obs) const override;
      virtual void setVisibilityAndObscurantAtAltitude(const double& altMSL, const double& distance, const int& obs) override;

      mutable tbb::spin_rw_mutex myMutex;
   };

   class DT_DLL_vrfStateData DtTroposphereStateComponentCurrentFrame : public DtStateComponentCurrentFrameTemplate< DtTroposphereStateComponent, DtTroposphereStateComponentNextFrame, DtTroposphereStateComponentData>
   {
   public:
      DtTroposphereStateComponentCurrentFrame(DtStateData* sd)
         : DtStateComponentCurrentFrameTemplate(sd)
      {
      };

      CURRENTFRAME_ACCESSOR_BY_REF(DtRwWindLevels, windLevels, WindLevels);
      CURRENTFRAME_ACCESSOR(int, priority, Priority);

      virtual const double windSpeed(double atAlt = 0.) const override;
      virtual const double windDirection(double atAlt = 0.) const override;
      virtual const double visibility(double atAltitude = 0.) const override;
      virtual const int obscurant(double atAltitude) const override;

      virtual bool windSpeedAndDirectionAtAltitude(double altMSL, double& windSpeed, double& windDirection) const override;

      virtual bool visibilityAndObscurantAtAltitude(double altMSL, double& distance, int& obs) const override;
   };

   using DtTroposphereStateComponentImplementation = DtStateComponentImplementationTemplate<DtTroposphereStateComponent, DtTroposphereStateComponentCurrentFrame, DtTroposphereStateComponentNextFrame>;

   typedef DtStateComponentCreator<DtTroposphereStateComponentImplementation> DtTroposphereStateComponentCreator;

}