DtVrlinkConnection.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/DtDriver.h>
#include <vrvVrl/DtVrlinkBaseConnection.h>

#include <vl/entityPublisher.h>

#include <unordered_map>
#include <boost/function.hpp>

class DtVrlApplicationInitializer;
class DtExerciseConnInitializer;
class DtExerciseConn;
class DtStealthControlPdu;

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

#if DtHLA
#include <vl/geodeticRegion.h>
#endif

namespace makVrv
{   
   class DtVrlinkDriver;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtEntityStateInterceptorCreator;

      class DL_DLL_IGCONVRLINK DtVrlinkConnection : public DtVrlinkBaseConnection
      {
      public:

         DtVrlinkConnection(DtAgentManagerInterface& aSceneInterface,
            const DtCoordinateSystem& coordSystem,
            const DtEntityAppearanceMapperFactoryCreator& appFactoryCreator,
            DtSharedSettingsManager& settingsManager,
            DtVrlinkDriver& driver);

         virtual ~DtVrlinkConnection();

         virtual void setExerciseConnInit(const DtVrlApplicationInitializer& exConnInitializer);

         virtual bool connect();

         virtual bool connected() const;

         virtual bool disconnect();

         virtual void tick(double dt);

         virtual double simTime() const;

         virtual void setSimTime(double simTime);

         virtual double clockTime() const;

         virtual DtTimeStampType timeStampType() const;


         virtual void setViewControlChanged( bool enabled );

         virtual void setUseTopoForFlatEarthVectorConversion( bool enabled );

         virtual void setConnectionFrameTime( double frameTime );

         virtual double connectionFrameTime() const;

         virtual void observerUpdated(const std::string& name,
            double x, double y, double z,
            double psi, double theta, double phi);

         virtual void observerUpdated(const std::string& observerName,
            double x, double y, double z,
            double psi, double theta, double phi,
            double dx, double dy, double dz,
            double dpsi, double dtheta, double dphi);

         virtual void stopPublishingObserver(const std::string& observerName);

         virtual void startPublishingObserver(const std::string& observerName);

         virtual void queueDriverFunction(boost::function<void()> func);

         virtual void queueConnectionFunction(boost::function<void()> func);

         virtual DtVrlinkDriver& vrlinkDriver();
         virtual const DtVrlinkDriver& vrlinkDriver() const;

         inline DtExerciseConn* exerciseConn()
         {
            return myExerciseConnection;
         }

         virtual const std::string& tag()
         {
#ifdef DtDIS
            const static std::string str("DIS");
#elif DtHLA_4
            const static std::string str("HLA4");
#elif DtHLA_1516_EVOLVED
            const static std::string str("HLA1516e");
#elif DtHLA_1516
            const static std::string str("HLA1516");
#elif DtHLA
            const static std::string str("HLA13");
#else
            const static std::string str("");
#endif
            return str;
         }


#if DtHLA
         inline const DtDDMRegionSet& regions() const
         {
            return myRegions;
         }

         virtual void addDdmRegionForObserver(const std::string& observerName);

         virtual void removeDdmRegionForObserver(const std::string& observerName);

         virtual void setDdmRegionSize(int sizeInMeters);

         virtual void setRegionUpdateThreshold(int percentage);

         virtual void setUseAltitudeThreshold(bool yesNo);

         virtual void setAltitudeThreshold(int meters);

         virtual void updateDdmRegion(const std::string& observerName,
            const DtVector& observerLocation);

         virtual void setRegionOutOfBounds(DtDDMRegionSP region);

         boost::signalslib::signal<void (DtDDMRegionSP)> signal_regionAdded;
         boost::signalslib::signal<void (DtDDMRegionSP)> signal_regionToBeRemoved;

#endif

#if DtDIS
         //Check to see if entity is published by this simulation.
         bool entityIsPublished(const DtEntityIdentifier& id) const;

         virtual bool timeoutProcessing() const;

         virtual void setTimeoutProcessing(bool enabled);

         virtual double timeoutInterval() const;

         virtual void setTimeoutInterval(double interval);
#endif      

         void setSupportsDelayedVisualizerCreation(bool);
         bool supportsDelayedVisualizerCreation() const;

         boost::signalslib::signal<void()> signal_exerciseConnectionCreated;
      protected:

         void addObserverPublisher(const std::string& observerName);

   protected:

         typedef std::unordered_map<std::string, DtEntityPublisher*> 
            ObserverPublisherMap;

         //Exercise Connection settings.
         DtExerciseConnInitializer* myExConnInitializer;


         //Active connection
         DtExerciseConn* myExerciseConnection;

#if DtHLA
         bool initializeDdm();

         DtDDMRegionSet myRegions;

         struct RegionInfo
         {
            DtGeodeticRegionSP region;
            DtVector           geocentricLocation;
            bool               outOfBounds;
         };

         typedef std::unordered_map<std::string, RegionInfo> ObserverRegions;
         ObserverRegions myObserverRegions;
         int myRegionUpdateThreshold;
         int myDdmRegionSize;
         bool myUseAltitudeThreshold;
         double myAltitudeThreshold;
#endif

#if DtDIS
         bool myTimeoutProcessing;
         double myTimeoutInterval;
#endif


         //Publishers for observers
         ObserverPublisherMap myObserverPublishers;
         bool myViewControlsEnabled;
         bool myUseTopoForFlatEarthVectorConversion;
         DtSignalConnectionManager myConnections;
         double myConnectionFrameTime;

         bool mySupportsDelayedVisualizerCreation;
         DtVrlinkDriver& myVrlinkDriver;
      };
   }
}