DtEnvironmentProcessor.h

Go to the documentation of this file.

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


#pragma once

#include <vrvVrl/vrvVrl.h>

#ifndef DT_PROTOCOL_NAMESPACE
#error Namespace Protocol Macro DT_PROTOCOL_NAMESPACE not defined.
#endif

#include <vrvVrl/DtCustomReflectedEnvironmentListTypes.h>

#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrvCore/DtUniqueID.h>

#include <unordered_map>

class DtVrlUuid;
class DtReflectedObject;
class DtEnvironmentConditionStateRepository;

namespace makVrv
{
   class DtEnvironmentStatusManager;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtVrlinkConnection;
      class DtCustomReflectedEnvironmentListCreator;


      class DL_DLL_IGCONVRLINK DtEnvironmentProcessor : public DtVirtualBaseClass
      {
      public:
         DtEnvironmentProcessor(DtVrlinkConnection& conn);

         virtual ~DtEnvironmentProcessor();

         DtEnvironmentProcessor() = delete;

         DtEnvironmentProcessor(const DtEnvironmentProcessor&) = delete;

         DtEnvironmentProcessor& operator=(const DtEnvironmentProcessor&) = delete;

      public:
         static void registerInstance(DtVrlinkConnection& conn, DtEnvironmentProcessor* instance);

         static DtEnvironmentProcessor* findInstance(DtVrlinkConnection& conn);

      public:
         // Returns false if the UUID is not found. 
         virtual bool getWeatherAreaIdFromMetocWeatherAreaUuid(const DtVrlUuid& uuid, DtUniqueID& vrvWeatherAreaId);

         virtual bool getVrvIdFromMetocUuid(const DtVrlUuid& weatherObjectUuid, DtUniqueID& envObjectId);

         virtual void onEnvironmentObjectDiscovered(DtEnvironmentConditionStateRepository* interceptor);

         virtual void onEnvironmentObjectToBeDestroyed(const DtEnvironmentConditionStateRepository* repository);

         virtual DtVrlinkReflectedTroposphereLayerList* findReflectedTroposphereLayerList();
         virtual DtVrlinkReflectedLandSurfaceList* findReflectedLandSurfaceList();
         virtual DtVrlinkReflectedWaterSurfaceList* findReflectedWaterSurfaceList();
         virtual DtVrlinkReflectedSubsurfaceLayerList* findReflectedSubsurfaceLayerList();

   protected:
      void startListening();

      void stopListening();

#if DtHLA
      virtual void addDdmRegion(DtDDMRegionSP regionToAdd);

      virtual void removeDdmRegion(DtDDMRegionSP regionToRemove);
#endif

      static bool discoverFunction(DtReflectedObject* refObj, void* usr);

      virtual bool discover(DtReflectedObject* refObj);

      // (Note, DtEnvironmentConditionStateRepository* should be const but isn't due to VR-Link issue)
      virtual bool determineWeatherAreaId(DtEnvironmentConditionStateRepository* repository, DtUniqueID& weatherAreaId);

      virtual bool getExistingWeatherAreaFromGeoReference(const DtGeoReferenceVariant& geoRef, DtUniqueID& weatherAreaId) const;

      virtual DtUniqueID newWeatherAreaFromGeoReference(const DtGeoReferenceVariant& geoRef);

      protected:

         DtVrlinkConnection& myConnection;
         DtSignalConnectionManager myConnections;
         DtEnvironmentStatusManager& myEnvironmentStatusManager;

         DtCustomReflectedEnvironmentListCreator* myReflectedTroposphereLayerListCreator;
         DtVrlinkReflectedTroposphereLayerList* myReflectedTroposphereLayerList;

         DtCustomReflectedEnvironmentListCreator* myReflectedWaterSurfaceListCreator;
         DtVrlinkReflectedWaterSurfaceList* myReflectedWaterSurfaceList;

         DtCustomReflectedEnvironmentListCreator* myReflectedLandSurfaceListCreator;
         DtVrlinkReflectedLandSurfaceList* myReflectedLandSurfaceList;

         DtCustomReflectedEnvironmentListCreator* myReflectedSubsurfaceLayerListCreator;
         DtVrlinkReflectedSubsurfaceLayerList* myReflectedSubsurfaceLayerList;

         // 
         // ID Spaces 
         // VR-Link will provide a DtUuid for each env object it conveys.  When MAK extensions
         // are used, a DtUuid will also be provided for weather areas.  Since weather areas can
         // contain separate layers there may be multiple env object DtUuids associated with a weather
         // area id.
         // VR-Vantage assigns DtUniqueIDs (the ids used throughout VRV) to both env object DtUUids and
         // to weather area DtUuids when provided.  When MAK extensions are NOT in use, a DtUniqueID is
         // still generated for each weather area, but there is no associated DtUuid from VR-Link.

         // type used for associating DtUuids (in string form) with VRV DtUniqueIDs (may be unique env object
         // identifiers, which are also used for layer ids for topo layer objects) or weather area ids.
         typedef std::unordered_map<std::string, DtUniqueID> VrlUuidToVrvIdMap;

         // map of metoc uuids (id for the env object itself) to the DtUniqueID assigned by VRV.  This VRV 
         // DtUniqueID is used to verify that a discovered object is new, and is used as a LAYER ID
         // for troposphere layer env objects
         VrlUuidToVrvIdMap myMetocUuidToVrvIdMap;

         // Map of MAK-extension weather area uuids to VRV weather area ids
         VrlUuidToVrvIdMap myMetocWeatherAreaUuidToWeatherAreaIdMap;

         // Associate the (potentially multiple) VRV DtUniqueIDs assigned to env objects with VRV weather area ids
         typedef std::unordered_multimap<DtUniqueID, DtUniqueID> WeatherAreaIdToVrvIdMap;
         WeatherAreaIdToVrvIdMap myWeatherAreaIdToVrvIdMap;

         // Map of known geoReference when not using mak extensions, keyed by VRV weather area ids assigned to them 
         std::unordered_map<DtUniqueID, DtGeoReferenceVariant*> myNonMakWeatherAreaMap;
      };


   } // protocol namespace
} // makVRV namespace