DtCigiConnection.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCigi/DtCigiConnSettingsHandler.h>
#include <vrvCigi/DtCigiConnectionInitializer.h>
#include <vrvCigi/DtCigiViewController.h>
#include <vrvCigi/DtComponentSignaler.h>
#include <vrvCigi/DtPositionResponder.h>
#include <vrvCigi/DtCollisionResponder.h>
#include <vrvCigi/DtHatHotResponder.h>

#include <vrvCore/DtBaseConnection.h>
#include <vrvCore/DtViewStateProcessor.h>

#include <matrix/vlVector.h>
#include <vlutil/vlPerformanceStats.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <CigiVersionID.h>


class CigiIGSession;
class CigiBasePacket;


namespace makVrv
{
   class DtDe; // for the creator class
   class DtCigiConnectionInitializer;
   class DtCigiNetworkIO;
   class DtAgentManagerInterface;
   class DtCigiEntityVisualizer;
   class DtCoordinateSystem;
   class DtSharedSettingsManager;
   class DtVirtualBaseClass;
   class DtCigiIgControlProcessor;
   class DtHatHotResponder;
   class DtLosResponder;
   class DtSensorResponder;
   class DtCigiLosBasicResponse;
   class DtCigiLosExtendedResponse;
   class DtCigiViewManager;
   class DtRenderSideCigiFrameAgent;

   class DT_DLL_VRVCIGI DtCigiConnection : public DtBaseConnection
   {
   public:
      enum DtIgMode
      {
         ResetStandby = 0,
         Operate = 1,
         Debug = 2
      };

      friend class DtCigiConnectionCreator;

      virtual ~DtCigiConnection();

      virtual void init();

      virtual bool tick( double elapsedTime );

      virtual bool connect();

      virtual bool disconnect();

      virtual void restart();

      virtual void reset();

      virtual void setConnectionInitializer(const DtCigiConnectionInitializer& init);

      virtual void sendCigiMessages();

      virtual const DtCigiEntityVisualizer& entityManager() const;
      virtual DtCigiEntityVisualizer& entityManager();

      virtual const DtCigiIgControlProcessor& igControlProcessor() const;
      virtual DtCigiIgControlProcessor& igControlProcessor();
            
      virtual const DtCigiNetworkIO& networkIO() const;
      virtual DtCigiNetworkIO& networkIO();

      virtual const DtCigiViewManager& viewManager() const;
      virtual DtCigiViewManager& viewManager();
      
      virtual const DtRenderSideCigiFrameAgent& renderSideCigiFrameAgent() const;
      virtual DtRenderSideCigiFrameAgent& renderSideCigiFrameAgent();

      virtual const makArchives::DtCigiSettingsRecord& cigiSettings() const;

      virtual void setLastHostFrameNumber(unsigned int frameNumber);
      
      virtual unsigned int lastHostFrameNumber() const;

      inline bool useSynchronousMode() const
      {
         return myUseSynchronousMode;
      }

      virtual void setIgMode(DtIgMode mode);

      inline DtIgMode igMode() const
      {
         return myMode;
      }

      virtual void setDatabaseNumber(int number);

      virtual int databaseNumber() const;

      virtual void setLoadingDatabase();

      virtual void setDatabaseLoaded();

      virtual void setExtrapolationEnabled(bool enabled);

      virtual bool extrapolationEnabled() const;

      virtual void setTimestampValid(bool valid);

      virtual bool timestampValid() const;

      virtual void setLastTimestamp(unsigned int timestamp);

      virtual unsigned int lastTimestamp() const;

      virtual void sendHatHotResponse( const DtHatHotResponder::DtHatHotResponseData* hatHotResponse );

      virtual void sendLosBasicResponse(DtCigiLosBasicResponse* losResponse);

      virtual void sendLosExtendedResponse(DtCigiLosExtendedResponse* losResponse);

      virtual void sendPositionResponse( DtPositionResponder::DtPositionResponseData& posResponse );

      virtual void sendCollisionSegmentResponse( DtCollisionResponder::DtCollisionSegmentResponseData& collResponse );

      virtual void sendSensorResponse( DtSensorResponder::DtSensorResponseData& sensorResponse );

      virtual void sendUserPacket( CigiBasePacket* packet );

      virtual const DtHatHotResponder& hatHotResponder() const;
      virtual DtHatHotResponder& hatHotResponder();

      virtual const DtLosResponder& losResponder() const;
      virtual DtLosResponder& losResponder();

      virtual const DtPositionResponder& positionResponder() const;
      virtual DtPositionResponder& positionResponder();

      virtual const DtCollisionResponder& collisionResponder() const;
      virtual DtCollisionResponder& collisionResponder();

      virtual const DtSensorResponder& sensorResponder() const;
      virtual DtSensorResponder& sensorResponder();

      virtual unsigned int currentIgFrame() const;

      virtual DtComponentSignaler& componentSignaler();

      virtual CigiIGSession& session();
      virtual const CigiIGSession& session() const;
      
      bool cigiSessionExists() const;

      virtual bool registerUserPacket(CigiBasePacket *packet, 
         unsigned int packetId, bool hostSend, bool igSend);

      virtual bool useThreadFlag() const;

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

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

      virtual DtCigiDriver& cigiDriver(); 
      

      virtual void startOverloadTimer();

      virtual void stopOverloadTimer();

      virtual bool overloaded();

      virtual void setWarnOnOverload( bool b );

      virtual bool warnOnOverload() const;

      virtual void setDropMessagesOnOverload( bool b );

      virtual bool dropMessagesOnOverload() const;

      virtual double hostFrequency() const;
      virtual void setHostFrequency( double freq );

      boost::signalslib::signal<void (DtViewStateProcessor::ObserverAction&)>
         signal_viewChanged;

      boost::signalslib::signal<void (int, DtUniqueID)> signal_alphaChanged;

      boost::signalslib::signal<void (int, int, int, int, int)> signal_timeSet;

      boost::signalslib::signal<void (bool)> signal_ephemerisEnableSet;

      boost::signalslib::signal<void (const std::string&)> signal_loadDatabase;

      boost::signalslib::signal<void ()> signal_connected;

      boost::signalslib::signal<void ()> signal_toBeDisconnected;

      boost::signalslib::signal<void (bool)> signal_deadReckoningAllowedChanged;

      boost::signalslib::signal<void( int entityId )> signal_entityToBeDeleted;

      virtual const CigiVersionID getCigiVersion() const;

      virtual const bool connectionObjectId() const;

      virtual void getConnectionObjectIDFromString( unsigned int& connectionID, std::string connectionObjectIDString);

      DtCigiConnection() = delete;
      DtCigiConnection( DtCigiConnection& ) = delete;
      DtCigiConnection( DtCigiConnection&& ) = delete;
      DtCigiConnection& operator=( DtCigiConnection& ) = delete;
      DtCigiConnection& operator=( DtCigiConnection&& ) = delete;
   protected:
      DtCigiConnection(const DtCigiConnectionInitializer& init,
         DtAgentManagerInterface& sceneInterface,
         DtSharedSettingsManager& settingsManager,
         DtCigiDriver& driver);

   protected:
      typedef std::map<std::string,DtVirtualBaseClass*> InstanceMap;

      DtCigiDriver&          myCigiDriver;
      DtCigiNetworkIO*       myNetworkIO;
      DtCigiEntityVisualizer*   myEntityManager;
      DtCigiConnectionInitializer myInitializer;
      DtCigiIgControlProcessor*     myIgController;
      DtCigiViewManager*       myViewManager;

      DtHatHotResponder*       myHatHotResponder;
      DtLosResponder*          myLosResponder;
      DtPositionResponder*     myPositionResponder;
      DtCollisionResponder*    myCollisionResponder;
      DtSensorResponder*       mySensorResponder;

      DtRenderSideCigiFrameAgent* myRenderSideCigiFrameAgent;

      DtComponentSignaler    myComponentSignaler;
      DtCigiConnSettingsHandler mySettingsHandler;
      bool                   myUseSynchronousMode;
      double myHostFrequency;

      unsigned int           myIgFrame;
      unsigned int           myLastHostFrameNumber;
      unsigned int           myLastProcessedHostFrameNumber;
      DtSignalConnectionManager mySignals;
      DtIgMode                  myMode;
      int                       myDatabaseNumber;
      bool                      myDatabaseLoading;
      bool                      myExtrapolationEnabled;
      bool                      myTimestampValid;
      unsigned int              myLastTimestamp;

      DtTimedSection myOverloadTimer;
      double myFrameTimeSoFar;
      bool myWarnOnOverload;
      bool myDropMessagesOnOverload;
      bool myResetCigiConnection;

      CigiVersionID myCigiVersion;
   };

   class DT_DLL_VRVCIGI DtCigiConnectionCreator : public DtVirtualBaseClass
   {
   public:     
      DtCigiConnectionCreator();

      virtual ~DtCigiConnectionCreator();

      static DtCigiConnectionCreator& instance( DtDe& de );

      virtual DtCigiConnection* create(const DtCigiConnectionInitializer& init,
         DtAgentManagerInterface& sceneInterface,
         DtSharedSettingsManager& settingsManager,
         DtCigiDriver& driver) const;
   };
}