simEventConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file simEventConnector.h
//! \brief Defines the base DtSimEventConnector class for VREngage simulation events
//!
//! This header provides the base class for all simulation event connectors in the
//! VREngage framework. The DtSimEventConnector serves as the foundation for more
//! specialized connectors that handle specific simulation events.
 
#pragma once
 
#include "vreMessageManager/vreMessage.h"
#include "vrePlayerStation/connector.h"
#include "vrePlayerStationConnector/export.h"
 
#if defined(DtDIS)
   #include <vrvDis/DtDisDriver.h>
#elif defined(DtHLA)
   #if defined(DtHLA_1516)
      #if defined(DtHLA_4)
         #include <vrvHla4/DtHla4Driver.h>
      #elif defined(DtHLA_1516_EVOLVED)
         #include <vrvHla1516e/DtHla1516eDriver.h>
      #else
         #include <vrvHla1516/DtHla1516Driver.h>
      #endif
   #else
      #include <vrvHla13/DtHla13Driver.h>
   #endif
#endif
 
#include <vrvVrl/DtVrlinkConnection.h>
 
namespace makVre
{
//! \brief Forward declaration of the player station application
class DtPlayerStationApp;
 
namespace DT_PROTOCOL_NAMESPACE
{
//! \brief Base class for all simulation event connectors in VREngage
//!
//! DtSimEventConnector provides the core functionality for connecting
//! VREngage components to simulation events from VR-Link. It serves as the base
//! class for more specialized connectors that handle specific event types like
//! entity updates, weapon fire, laser designators, etc.
//!
//! The connector is protocol-specific, with behavior determined by the
//! DT_PROTOCOL_NAMESPACE macro (DIS, HLA 1.3, HLA 1516, or HLA 1516e).
class VRL_DLL DtSimEventConnector : public DtConnector
{
public:
   //! \brief Default constructor
   //!
   //! Initializes member variables and sets the connector type based on
   //! the current protocol (DIS, HLA 1.3, HLA 1516, or HLA 1516e)
   DtSimEventConnector();
 
   //! \brief Virtual destructor
   virtual ~DtSimEventConnector() override;
 
   //! \brief Installs the connector with the application and connection
   //! \param app Pointer to the player station application
   //! \param connection Pointer to the protocol-specific VR-Link connection
   //!
   //! This method stores the application and connection pointers for later use.
   //! Derived classes should override this method to perform additional setup,
   //! but should call the base class implementation first.
   virtual void install(DtPlayerStationApp* app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection);
 
   //! \brief Performs periodic processing
   //!
   //! This method is called periodically to allow the connector to perform
   //! any regular processing tasks. The default implementation does nothing.
   //! Derived classes should override this method if they need to perform
   //! periodic processing.
   virtual void tick() {}
 
   //! \brief Shuts down the connector
   //!
   //! This method is called when the connector is being shut down. The default
   //! implementation does nothing. Derived classes should override this method
   //! to perform any necessary cleanup, such as disconnecting signals.
   virtual void shutdown() {}
 
protected:
   //! \brief Pointer to the player station application
   //!
   //! This is set in the install() method and provides access to the
   //! VREngage application services.
   DtPlayerStationApp* myApp;
 
   //! \brief Pointer to the protocol-specific VR-Link connection
   //!
   //! This is set in the install() method and provides access to the
   //! simulation networking services.
   makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* myConnection;
};
} // namespace DT_PROTOCOL_NAMESPACE
} // namespace makVre