connectorAccessory.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file connectorAccessory.h
//! \brief Contains the DtConnectorAccessory class that manages VREngage connectivity
//!
//! This accessory establishes the connection between VREngage components and VR-Link,
//! handling installation, connection events, coordinate systems, and event messaging.
 
#include "vrePlayerStationConnector/export.h"
#include "vrePlayerStationConnector/simEventConnector.h"
 
 
#ifndef DT_PROTOCOL_NAMESPACE
   #error Namespace Protocol Macro DT_PROTOCOL_NAMESPACE not defined.
#endif
 
#pragma once
 
#include <vrvCore/DtBaseAccessory.h>
 
#include <list>
 
namespace makVrv
{
class DtVrlinkDriver;
class DtVrlinkBaseConnection;
class DtCoordinateSystem;
 
namespace DT_PROTOCOL_NAMESPACE
{
class DtVrlinkConnection;
}
} // namespace makVrv
 
namespace makVrf
{
class DtVrlinkNetworkInterface;
}
 
namespace makVre
{
//! \brief Forward declaration of the player station application
class DtPlayerStationApp;
 
//! \brief Forward declaration of the network forwarder
class DtExerciseConnNetworkForwarder;
 
//! \brief Forward declaration of the message factory
class DtVreMessageFactory;
 
//! \brief Forward declaration of the communication manager
class DtVreCommunicationManager;
 
namespace DT_PROTOCOL_NAMESPACE
{
//! \brief Forward declaration of the simulation event connector
class DtSimEventConnector;
 
//! \brief Accessory that manages connections between VREngage and VR-Link
//!
//! DtConnectorAccessory establishes and manages the connection between VREngage
//! components and the VR-Link simulation environment. It handles installation of
//! various connector types, manages connection events, coordinates system changes,
//! and processes simulation messages.
//!
//! This class is protocol-specific, with behavior defined by the DT_PROTOCOL_NAMESPACE macro
//! which determines whether DIS, HLA 1.3, HLA 1516, or HLA 1516e is being used.
class VRL_DLL DtConnectorAccessory : public makVrv::DtBaseAccessory
{
public:
   //! \brief Constructor for the connector accessory
   //! \param de Reference to the distributed environment to use
   //!
   //! Initializes member variables and sets up message handlers for connector
   //! installation and removal
   DtConnectorAccessory(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Disconnects signals, cleans up connections, and removes message handlers
   virtual ~DtConnectorAccessory() override;
 
   //! \brief Determines if this accessory is compatible with a given driver
   //! \param driver Pointer to the driver to check compatibility with
   //! \return True if compatible, false otherwise
   //!
   //! Checks if the driver is of the correct protocol-specific type for this accessory
   virtual bool isCompatible(makVrv::DtDriver* driver) override;
 
   //! \brief Installs this accessory into a compatible driver
   //! \param driver Pointer to the driver to install this accessory into
   //!
   //! Connects signals, sets up callbacks, and prepares the accessory for use
   virtual void install(makVrv::DtDriver* driver) override;
 
   //! \brief Uninstalls this accessory from a driver
   //! \param baseConn Pointer to the driver to uninstall from
   //!
   //! Removes all connectors, disconnects signals, and cleans up resources
   virtual void uninstall(makVrv::DtDriver* baseConn) override;
 
   //! \brief Callback for when a simulation connection is created
   //! \param connection Pointer to the newly created connection
   //!
   //! Sets up the connection, registers extensions, and prepares coordinate systems
   virtual void slot_onSimCreated(makVrv::DtVrlinkBaseConnection* connection);
 
   //! \brief Callback for when a simulation connection is established
   //! \param connection Pointer to the connected connection
   //!
   //! Initializes simulation parameters, installs connectors, and sends notification
   virtual void slot_onSimConnected(makVrv::DtVrlinkBaseConnection* connection);
 
   //! \brief Callback for when the coordinate system changes
   //! \param connection Pointer to the connection with the changed coordinate system
   //!
   //! Updates the coordinate system for all components
   virtual void slot_onCoordinateSystemChanged(makVrv::DtVrlinkBaseConnection* connection);
 
   //! \brief Callback for when a simulation is about to disconnect
   //! \param connection Pointer to the connection about to disconnect
   //!
   //! Cleans up resources and sends notifications before disconnection
   virtual void slot_onSimAboutToBeDisconnected(makVrv::DtVrlinkBaseConnection* connection);
 
   //! \brief Callback for periodic thread ticks
   //!
   //! Processes time updates and performs periodic tasks
   virtual void slot_onThreadTick();
 
   //! \brief Sets the coordinate system for the simulation
   //! \param vrvCS Reference to the coordinate system to use
   //!
   //! Creates and configures the appropriate coordinate converter based on the
   //! provided coordinate system
   virtual void setCoordinateSystem(const makVrv::DtCoordinateSystem& vrvCS);
 
protected:
   //! \brief Handles messages to install connectors
   //! \param msg Pointer to the message containing installation parameters
   //! \return Message result indicating how the message was handled
   //!
   //! Processes requests to install specific connectors for an entity
   virtual makVre::DtVreMessageResult handleInstallConnectors(makVre::DtVreMessage* msg);
 
   //! \brief Handles messages to remove connectors
   //! \param msg Pointer to the message containing removal parameters
   //! \return Message result indicating how the message was handled
   //!
   //! Processes requests to remove specific connectors for an entity
   virtual makVre::DtVreMessageResult handleRemoveConnectors(makVre::DtVreMessage* msg);
 
   //! \brief Installs the base set of connectors for the simulation
   //!
   //! Creates and installs the standard set of connectors that all simulations need
   virtual void installBaseConnectors();
 
   //! \brief Uninstalls all base connectors
   //!
   //! Cleans up and removes all base connectors
   virtual void uninstallBaseConnectors();
 
   //! \brief Clears all entity-specific connectors
   //!
   //! Removes all connectors associated with specific entities
   virtual void clearEntityConnectors();
 
protected:
   //! \brief Reference to the distributed environment
   makVrv::DtDe& myDe;
 
   //! \brief Pointer to the player station application
   makVre::DtPlayerStationApp* myApp;
 
   //! \brief Type of connector being used
   makVre::DtConnector::DtConnectorType myType;
 
   //! \brief List of base simulation event connectors
   //!
   //! These connectors handle core simulation functionality and are not entity-specific
   std::list<makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector*> myBaseConnectors;
 
   //! \brief Map of entity-specific connectors grouped by entity ID and connector name
   //!
   //! First key is entity ID, second key is connector name, value is the connector instance
   std::map<std::string, std::map<std::string, makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector*>> myEntityConnectors;
 
   //! \brief Pointer to the VR-Link driver
   makVrv::DtVrlinkDriver* myDriver;
 
   //! \brief Pointer to the protocol-specific VR-Link connection
   makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* myVrlConnection;
 
   //! \brief Pointer to the message factory for creating VREngage messages
   DtVreMessageFactory* myMessageFactory;
 
   //! \brief Pointer to the network forwarder for transferring messages
   DtExerciseConnNetworkForwarder* myNetworkForwarder;
 
   //! \brief Pointer to the communication manager that handles messages
   DtVreCommunicationManager* myCommunicationManager;
 
   //! \brief Pointer to the VR-Link network interface
   makVrf::DtVrlinkNetworkInterface* myVrlinkNetworkInterface;
};
} // namespace DT_PROTOCOL_NAMESPACE
} // namespace makVre