radioManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file radioManager.h
//! \ingroup vreMakRadio
//! \brief VREngage radio management system integration
//!
//! This file defines the DtVreRadioManager class which provides integration between
//! VREngage and the MAK Radio communications subsystem. It manages radio devices,
//! configurations, and provides the interface for radio operations within the simulation.
 
#pragma once
 
#include <vreMakRadio/export.h>
 
#include <makRadio/radioManager.h>
 
#include <vrvCore/DtDe.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vreUtil/initializer.h>
 
namespace makVrv
{
class DtDe;
}
 
namespace makVre
{
//! \brief VREngage radio manager class for controlling radio communications
//!
//! This class extends the base radio manager functionality and integrates with VREngage
//! to provide radio communications capabilities within simulations. It manages all radios,
//! handles configuration, and provides the central interface for radio operations.
class DT_DLL_VREMAKRADIO DtVreRadioManager : public makRadio::DtRadioManager, public makVrv::DtVirtualBaseClass
{
public:
   //! \brief Gets the singleton instance of the radio manager
   //! \param de Reference to the display engine to integrate with
   //! \return Reference to the singleton radio manager instance
   //!
   //! This static method follows the singleton pattern, creating the instance
   //! if it doesn't exist or returning the existing one if it does.
   static DtVreRadioManager& instance(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   virtual ~DtVreRadioManager() override;
 
   //! \brief Initializes the radio manager
   //! \param init Initialization table containing radio configuration data
   //! \param captureDevice Name of the audio capture device to use for radio input
   //!
   //! This method initializes the radio manager with the specified configuration
   //! and sets up the audio capture device for radio input.
   virtual void init(makVre::DtInitTable& init, const std::string& captureDevice);
 
   //! \brief Shuts down the radio manager
   //!
   //! This method properly shuts down the radio manager, releasing all resources
   //! and cleaning up any active radio connections.
   virtual void shutdown() override;
 
   //! \brief Sets the currently active radio
   //! \param radio Pointer to the radio to set as current
   //!
   //! This method sets the specified radio as the currently active radio
   //! for transmission and reception operations.
   virtual void setCurrentRadio(makRadio::DtRadio* radio) override;
 
   //! \brief Adds a new radio with the specified state
   //! \param state Initial radio state configuration
   //! \return Pointer to the newly created radio
   //!
   //! This method creates a new radio with the provided state configuration
   //! and adds it to the radio manager's collection of managed radios.
   virtual makRadio::DtRadio* addRadio(makRadio::DtRwRadioState& state);
 
   //! \brief Removes a radio at the specified index
   //! \param idx Index of the radio to remove
   //!
   //! This method removes the radio at the specified index from the manager's
   //! collection and properly cleans up its resources.
   virtual void removeRadio(int idx) override;
 
protected:
   //! \brief Protected constructor for singleton pattern
   DtVreRadioManager();
 
   //! \brief Configures radios from initialization data
   //! \param radios Initialization table containing radio configurations
   //!
   //! This method configures all radios based on the data in the initialization table.
   virtual void configureRadios(makVre::DtInitTable& radios);
 
   //! \brief Recreates all managed radios
   //!
   //! This method recreates all radios after a configuration change or reset.
   virtual void recreateRadios() override;
};
} // namespace makVre