weatherLocalNetInterface.h

Go to the documentation of this file.

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



#pragma once

#include "vrlinkNetworkInterface/vrlinkNetworkInterfaceDefines.h"
#include "vrlinkNetworkInterface/simLocalControlObjectNetInterface.h"
#include "vrlinkNetworkInterface/localExtendedPropertiesNetInterface.h"
#include <vrfExtObjects/weatherObjectRepository.h>
#include <vlutil/vlString.h>
#include <vlutil/vlList.h>
#include <vl/globalObjectDesignator.h>
#include <vrfExtObjects/simEnvironmentalModelType.h>
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <vlpi/metocEnums.h>

class DtEnvironmentProcessRepository;
class DtTroposphereLayerPublisher;
class DtSurface;
class DtObjectType;

class DtTroposphereLayerPublisher;
class DtSubsurfaceLayerPublisher;
class DtLandSurfacePublisher;
class DtWaterSurfacePublisher;
class DtServicePublisher;
class DtWeatherStateRepository;
class DtEnvironmentConditionStateRepository;



namespace makVrf
{
   class DtTroposphereStateComponent;
   class DtLandSurfaceStateComponent;
   class DtWaterSurfaceStateComponent;
   class DtSubsurfaceStateComponent;

   struct DtWeatherStateComponents
   {
      const DtTroposphereStateComponent* troposphereStateComp;
      const DtLandSurfaceStateComponent* landSurfaceStateComp;
      const DtWaterSurfaceStateComponent* waterSurfaceStateComp;
      const DtSubsurfaceStateComponent* subsurfaceStateComp;

      bool allComponentsValid() const;
      bool isModified() const;
   };

   class DT_DLL_vrlinkNetworkInterface DtWeatherLocalNetInterface :
      public DtLocalExtendedPropertiesNetInterface<DtSimLocalControlObjectNetInterface, DtWeatherObjectRepository>
   {
   private:
      DtWeatherLocalNetInterface();
      DtWeatherLocalNetInterface(const DtWeatherLocalNetInterface & orig);
      const DtWeatherLocalNetInterface & operator=(const 
         DtWeatherLocalNetInterface & orig);

   public:

      DtWeatherLocalNetInterface(DtStateData* vrfObject, DtVrlinkNetworkInterface*, bool publishObject = true);

      virtual ~DtWeatherLocalNetInterface();

      virtual bool init(const DtEntityIdentifier& id = DtEntityIdentifier::nullId());

      virtual void updatePublisher();

      virtual DtString type() const;

      static DtSimObjectNetInterface* creator(
         DtStateData* vrfObject,  DtVrlinkNetworkInterface*, bool publishObject);

      virtual void destroyPublisher();

   protected:
      virtual DtEnvironmentProcessRepository* epsr() const;

      virtual void setupRecords();

      virtual void updateGeometryRecord();
      virtual void updateWindLayers();

      virtual DtVrfExtControlObjectPublisher* _createVrfExtPublisher() override;

      virtual void setupMetocPublisher();

      virtual void metocTick();

      virtual void updateMetocPublishers();

      virtual void updateMetocLandSurfacePublishers(const DtWeatherStateComponents&);

      virtual void updateMetocSubsurfacePublishers(const DtWeatherStateComponents&);

      virtual void updateMetocWaterSurfacePublishers(const DtWeatherStateComponents&);

      virtual void updateMetocTropospherePublishers(const DtWeatherStateComponents&);

      virtual void updateCommonMetocWeatherRepository(const DtWeatherStateComponents&, DtWeatherStateRepository* repo);

      virtual void updateMetocGeoreference(const DtWeatherStateComponents&, DtEnvironmentConditionStateRepository* repo);
   public:

      virtual std::vector<unsigned> mapCloudStateToLayerAltitudes(DtVrfWeatherCloudState cloudState) const;
      virtual DtCloudTypeEnum32 mapVrvCloudTypeToMetocCloudType(int) const;
      virtual DtCloudTypeEnum32 mapCloudStateToCloudType(DtVrfWeatherCloudState cloudState, unsigned altitude) const;
      virtual float mapCloudStateToCloudCoverage(DtVrfWeatherCloudState cloudState, unsigned altitude) const;
      virtual float mapCloudStateToCloudDensity(DtVrfWeatherCloudState cloudState, unsigned altitude) const;

      virtual DtPrecipitationTypeEnum32 mapVrfPrecipitationtypeToMetocPrecipitationType(int vrfPrecipitationType) const;

      virtual DtHazeTypeEnum32 mapFogColorToHazeType(const DtVector& fogColor);
      virtual DtHazeTypeEnum32 mapObscurantToHazeType(int obscurant);

      static float mapSwellStateToSwellHeight(int state);
      static float mapSwellStateToSwellLength(int state);
      static int mapSwellStateToSwellPeriod(int state);

      static float mapSeaStateToWaveHeight(int state);
      static float mapSeaStateToWaveLength(int state);
      static int mapSeaStateToWavePeriod(int state);
      virtual DtGeoLocationTypeEnum32 mapEntityTypeToGeoLocationType(const DtObjectType& type);
   protected:
      virtual DtSubsurfaceLayerPublisher* createAndInitMetocSubsurfacePublisher() const;
      virtual DtLandSurfacePublisher* createAndInitMetocLandSurfacePublisher() const;
      virtual DtWaterSurfacePublisher* createAndInitMetocWaterSurfacePublisher() const;
      virtual DtTroposphereLayerPublisher* createAndInitMetocTropospherePublisher() const;
      virtual void initializeMetocStateRep(DtEnvironmentConditionStateRepository* sr) const;


      virtual void onTick() override;

   protected:
      DtLandSurfacePublisher* myMetocSurfacePublisher;
      DtWaterSurfacePublisher* myMetocWaterPublisher;
      std::vector<DtTroposphereLayerPublisher*> myMetocTropospherePublishers;
      std::vector<DtSubsurfaceLayerPublisher*> myMetocSubsurfacePublishers;

      bool mySetMetocGeoreference;
      DtGeoLocationTypeEnum32 myMetocGeoLocationType;
      static DtObjectType theAreaType;
      static DtObjectType theBoxType;
      static DtObjectType theCircleType;
   };
}