vreConnectionInformation.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file vreConnectionInformation.h
//! \ingroup vrePlayerStation.dll
//! \brief Contains the DtVreConnectionInformation class for managing VR-Link connections and their settings
 
#pragma once
 
#ifndef DT_PROTOCOL_NAMESPACE
   #error Namespace Protocol Macro DT_PROTOCOL_NAMESPACE not defined.
#endif
 
 
#include "vrePlayerStationConnector/export.h"
#include <vrvUtil/DtVirtualBaseClass.h>
#include "vreMessageManager/vreMessage.h"
 
namespace makVrv
{
class DtDriver;
class DtDe;
} // namespace makVrv
 
namespace makVre
{
namespace DT_PROTOCOL_NAMESPACE
{
//! \brief This class manages connection information for simulation drivers
//!
//! DtVreConnectionInformation handles the configuration, creation, and management of
//! simulation connection drivers (HLA, DIS). It processes connection requests,
//! manages connection settings, and handles messages related to connection status.
class VRL_DLL DtVreConnectionInformation : public makVrv::DtVirtualBaseClass
{
public:
   //! \brief Constructor for connection information manager
   //! \param de Reference to the distributed environment to use
   DtVreConnectionInformation(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Disconnects from signal handlers and removes message handlers
   virtual ~DtVreConnectionInformation() override;
 
   //! \brief Gets or creates a singleton instance of DtVreConnectionInformation
   //! \param de Reference to the distributed environment
   //! \return Reference to the singleton instance
   //!
   //! If an instance doesn't exist, one will be created and registered with the DE
   static DtVreConnectionInformation& instance(makVrv::DtDe& de);
 
   //! \brief Registers an instance with the distributed environment
   //! \param de Reference to the distributed environment
   //! \param instance Pointer to the instance to register
   static void registerInstance(makVrv::DtDe& de, DtVreConnectionInformation* instance);
 
   //! \brief Factory method to create a new connection information manager
   //! \param de Reference to the distributed environment to use
   //! \return Pointer to a newly created DtVreConnectionInformation
   static DtVreConnectionInformation* creator(makVrv::DtDe& de);
 
   //! \brief Initializes message handlers after DE initialization
   //!
   //! Registers message handlers for connection information requests, updates, and stops
   virtual void postInit();
 
   //! \brief Callback invoked when a driver is created
   //! \param con Reference to the newly created driver
   virtual void onDriverCreated(makVrv::DtDriver& con);
 
   //! \brief Callback invoked just before auto-drivers are loaded
   virtual void onAutoDriversAboutToBeLoaded();
 
protected:
   //! \brief Handles requests for connection information
   //! \param msg Pointer to the message containing the request
   //! \return Message result indicating success or failure
   //!
   //! Processes requests for connection configuration information
   //! and responds with current connection settings
   virtual makVre::DtVreMessageResult handleConnectionInfoRequest(makVre::DtVreMessage* msg);
 
   //! \brief Handles messages to set connection information
   //! \param msg Pointer to the message containing the settings to apply
   //! \return Message result indicating success or failure
   //!
   //! Applies connection settings from the message to the driver,
   //! creates new drivers if necessary, and saves settings to file
   virtual makVre::DtVreMessageResult handleConnectionInfoSet(makVre::DtVreMessage* msg);
 
   //! \brief Handles messages about connection updates
   //! \param msg Pointer to the message containing update information
   //! \return Message result indicating success or failure
   //!
   //! Updates connection settings for existing drivers
   virtual makVre::DtVreMessageResult handleConnectionUpdated(makVre::DtVreMessage* msg);
 
   //! \brief Handles messages to stop a connection
   //! \param msg Pointer to the message requesting connection stop
   //! \return Message result indicating success or failure
   //!
   //! Processes requests to stop a driver and disconnects it
   virtual makVre::DtVreMessageResult handleStopConnection(makVre::DtVreMessage* msg);
 
protected:
   //! \brief Reference to the distributed environment
   makVrv::DtDe& myDe;
 
   //! \brief Protocol-specific driver name, determined at compile time
   //!
   //! This is set to "Dis", "Hla13", "Hla1516", or "Hla1516e" depending on
   //! which protocol is being compiled
   static const std::string theDriverName;
};
} // namespace DT_PROTOCOL_NAMESPACE
} // namespace makVre