cigiHost.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! @file cigiHost.h
//!
//! @brief Singleton foundation for the vreCigiHost system.
//!
//! Creates and manages CigiSession instances as requested by message
//! from VR-Engage PlayerStations.
 
#include "vreCigiHost/export.h"
 
#include "vreMessageManager/vreMessage.h"
 
#include "vreUtil/baseClass.h"
#include "vreUtil/delegate.h"
 
#include <boost/signals2/connection.hpp>
 
#include <map>
#include <list>
#include <memory>
#include <string>
 
class DtCgf;
class DtSimObjectManager;
class DtSimulationServices;
 
namespace makVre
{
class DtCigiSession;
class DtCigiDataBase;
 
 
class CIGIHOST_DLL DtCigiHost : public DtSpSubClass<DtCigiHost>
{
public:
   using SharedDataPtr = std::shared_ptr<DtCigiDataBase>;
 
   static Ptr instance();
   static void destroy();
 
   DtCigiHost();
   virtual ~DtCigiHost() override;
 
   virtual Sptr setCgf(DtCgf& cgf);
   virtual DtCgf& cgf();
 
   virtual void init();
   virtual void tick();
   virtual unsigned int frame() const;
 
   static void cgfAboutToBeDestroyedCallback(void*);
 
   virtual bool shuttingDown();
 
   virtual SharedDataPtr fetchSharedData(const std::string& key);
   virtual void addSharedData(const std::string& key, SharedDataPtr data);
 
   using SessionCallback = DtDelegate<void, DtCigiSession&>;
   virtual void addSessionStartedCallback(const SessionCallback& cb);
   virtual void removeSessionStartedCallback(const SessionCallback& cb);
   virtual void addSessionEndingCallback(const SessionCallback& cb);
   virtual void removeSessionEndingCallback(const SessionCallback& cb);
 
protected:
   virtual void shutdown();
 
   virtual void processSessionsEnding();
 
   virtual DtVreMessageResult handleCigiStartSessionMessage(DtVreMessage* msg);
   virtual DtVreMessageResult handleCigiStopSessionMessage(DtVreMessage* msg);
 
protected:
   static Sptr theHost;
 
   DtCgf* myCgf;
 
   boost::signals2::scoped_connection myTickConnection;
 
   unsigned int myFrame;
   double myLastTickTime;
   bool myShuttingDown;
 
   using SharedDataRef = std::weak_ptr<DtCigiDataBase>;
   using SharedDataMap = std::map<std::string, SharedDataRef>;
   SharedDataMap mySharedDataObjects;
 
   using SessionPtr = std::shared_ptr<DtCigiSession>;
   using SessionRef = std::weak_ptr<DtCigiSession>;
   using SessionsByName = std::map<std::string, SessionPtr>;
   using SessionsByEndpoint = std::map<std::string, SessionRef>;
   using SessionsByHostPort = std::map<unsigned int, SessionRef>;
 
   SessionsByName mySessionsByName;
   SessionsByEndpoint mySessionsByEndpoint;
   SessionsByHostPort mySessionsByHostPort;
 
   std::list<SessionCallback> mySessionStartedCallbacks;
   std::list<SessionCallback> mySessionEndingCallbacks;
};
 
// Utility function for Entity list management
template <typename LIST_T>
void pruneReferenceMap(LIST_T& map)
{
   auto it = map.begin();
   while (it != map.end())
   {
      if (it->second.expired())
      {
         it = map.erase(it);
      }
      else
      {
         ++it;
      }
   }
}
 
} // namespace makVre