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 <vlutil/vlString.h>
#include <vlutil/vlList.h>
#include <vl/globalObjectDesignator.h>
#include <vrfExtObjects/simEnvironmentalModelType.h>
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <vrfMetoc/metocEnums.h>

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

namespace makVrfMetoc
{
   class DtTroposphereLayerPublisher;
   class DtSubsurfaceLayerPublisher;
   class DtLandSurfacePublisher;
   class DtWaterSurfacePublisher;
   class DtServicePublisher;
   class DtWeatherStateRepository;
   class DtEnvironmentConditionStateRepository;
}

#ifdef DtDIS
typedef void* DtVrfTropospherePublisherPtr;
typedef void* DtVrfSubsurfacePublisherPtr;
typedef void* DtVrfLandSurfacePublisherPtr;
typedef void* DtVrfWaterSurfacePublisherPtr;
typedef void* DtVrfServicePublisherPtr;
typedef void* DtVrfWeatherStateRepositoryPtr;
typedef void* DtVrfEnvironmentConditionStateRepositoryPtr;
#else
typedef makVrfMetoc::DtTroposphereLayerPublisher* DtVrfTropospherePublisherPtr;
typedef makVrfMetoc::DtSubsurfaceLayerPublisher* DtVrfSubsurfacePublisherPtr;
typedef makVrfMetoc::DtLandSurfacePublisher* DtVrfLandSurfacePublisherPtr;
typedef makVrfMetoc::DtWaterSurfacePublisher* DtVrfWaterSurfacePublisherPtr;
typedef makVrfMetoc::DtServicePublisher* DtVrfServicePublisherPtr;
typedef makVrfMetoc::DtWeatherStateRepository* DtVrfWeatherStateRepositoryPtr;
typedef makVrfMetoc::DtEnvironmentConditionStateRepository* DtVrfEnvironmentConditionStateRepositoryPtr;
#endif

namespace makVrf
{
   class DtWeatherStateComponent;

   class DT_DLL_vrlinkNetworkInterface DtWeatherLocalNetInterface : public DtSimLocalControlObjectNetInterface
   {
   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 int weatherRecordIndex() const;
      virtual void destroyPublisher();

   protected:
      virtual DtEnvironmentProcessRepository* epsr() const;

      virtual void setupRecords();

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

      virtual DtEnvironmentProcessPublisher* _createPublisher(const DtEntityIdentifier& id = DtEntityIdentifier::nullId());
      virtual bool createPublisher(const DtEntityIdentifier& entityId);

      virtual void setupMetocPublisher();

      virtual void metocTick();

      virtual void updateMetocPublishers();

      virtual void updateMetocSurfacePublishers(const DtWeatherStateComponent*);

      virtual void updateMetocSubsurfacePublishers(const DtWeatherStateComponent*);

      virtual void updateMetocWaterPublishers(const DtWeatherStateComponent*);

      virtual void updateMetocTropospherePublishers(const DtWeatherStateComponent*);

      virtual void updateCommonMetocWeatherRepository(const DtWeatherStateComponent*, DtVrfWeatherStateRepositoryPtr repo);

      virtual void updateMetocGeoreference(const DtWeatherStateComponent*, DtVrfEnvironmentConditionStateRepositoryPtr repo);


      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);

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

      virtual float mapSeaStateToWaveHeight(int state);
      virtual float mapSeaStateToWaveLength(int state);
      virtual int mapSeaStateToWavePeriod(int state);
      virtual DtGeoLocationTypeEnum32 mapEntityTypeToGeoLocationType(const DtObjectType& type);

#ifndef DtDIS
      virtual DtVrfSubsurfacePublisherPtr createAndInitMetocSubsurfacePublisher() const;
      virtual DtVrfLandSurfacePublisherPtr createAndInitMetocLandSurfacePublisher() const;
      virtual DtVrfWaterSurfacePublisherPtr createAndInitMetocWaterSurfacePublisher() const;
      virtual DtVrfTropospherePublisherPtr createAndInitMetocTropospherePublisher() const;
      virtual void initializeMetocStateRep(makVrfMetoc::DtEnvironmentConditionStateRepository* sr) const;
#endif

      virtual void onTick() override;

   protected:
      DtVrfEnvironmentalWeatherStateRecord* myEnvironmentalStateRecord;

      DtVrfSubsurfacePublisherPtr myMetocSubsurfacePublisher;
      DtVrfLandSurfacePublisherPtr myMetocSurfacePublisher;
      DtVrfWaterSurfacePublisherPtr myMetocWaterPublisher;
      std::vector<DtVrfTropospherePublisherPtr> myMetocTropospherePublishers;

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