radioStackWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file radioStackWidget.h
//! \ingroup vrfMakRadioQt
//! \brief Radio stack widget for managing multiple radio interfaces
//!
//! This file defines the DtRadioStackWidget class, which provides a container
//! for managing multiple radio interfaces in the VREngage environment. It allows
//! users to control multiple radio channels through a consistent interface.
 
#pragma once
 
#include <vrvUtil/signalslib.h>
 
#include "radioStackWidget.hpp"
 
#include <QtWidgets/QWidget>
 
#include <vlpi/entityIdentifier.h>
 
class QTimer;
class QStandardItemModel;
class QSortFilterProxyModel;
 
namespace makVrv
{
class DtVrvRadioManager;
class DtRadioWidget;
 
//! \brief Radio stack widget for managing multiple radio interfaces
//!
//! This widget provides a container for managing multiple radio interfaces
//! in the VREngage environment. It allows users to control and monitor multiple
//! radio channels through a single consistent interface, including volume control,
//! push-to-talk functionality, and voice activation detection (VOX).
class DtRadioStackWidget : public QWidget
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param mgr The radio manager providing access to radio functionality
   //! \param parent The parent widget (optional)
   //! \param f Window flags (optional)
   //!
   //! Creates a new radio stack widget with the specified radio manager and parent.
   DtRadioStackWidget(DtVrvRadioManager* mgr, QWidget* parent = 0, Qt::WindowFlags f = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the radio stack widget.
   virtual ~DtRadioStackWidget();
 
   //! \brief Adds an entity to the radio system
   //! \param markingText The marking text identifying the entity to add
   //!
   //! Adds an entity with the specified marking text to the radio system,
   //! making it available for radio communications.
   virtual void addEntity(std::string markingText);
 
   //! \brief Removes an entity from the radio system
   //! \param markingText The marking text identifying the entity to remove
   //!
   //! Removes an entity with the specified marking text from the radio system,
   //! disconnecting it from radio communications.
   virtual void removeEntity(std::string markingText);
 
   //! \brief Gets the radio manager
   //! \return Reference to the radio manager
   //!
   //! Returns a reference to the radio manager used by this stack widget.
   virtual DtVrvRadioManager& radioManager();
 
public slots:
   //! \brief Slot called when the selected entity changes
   //! \param idx The index of the newly selected entity
   //!
   //! Updates the radio display to show the radios for the newly selected entity.
   virtual void entityChanged(int idx);
 
   //! \brief Slot called when the master volume changes
   //! \param value The new volume value
   //!
   //! Updates the volume for all radio channels.
   virtual void masterVolumeChanged(int value);
 
   //! \brief Slot called when the master VOX setting changes
   //! \param value The new VOX threshold value
   //!
   //! Updates the voice activation detection threshold for all radio channels.
   virtual void masterVoxChanged(int value);
 
   //! \brief Slot called when the master push-to-talk button is pressed
   //!
   //! Activates transmission on all active radio channels.
   virtual void masterPttPressed();
 
   //! \brief Slot called when the master push-to-talk button is released
   //!
   //! Deactivates transmission on all active radio channels.
   virtual void masterPttReleased();
 
   //! \brief Updates the radio display
   //!
   //! Refreshes the display of all radio controls to reflect current state.
   virtual void updateRadios();
 
   //! \brief Updates signal level indicators
   //!
   //! Updates the signal level indicators for all active radio channels.
   virtual void updateLevels();
 
protected:
   //! \brief Creates radio widgets for the current entity
   //!
   //! Creates and initializes the radio widgets for the currently selected entity.
   virtual void createRadios();
 
   //! \brief Filters events for radio widgets
   //! \param watched The object being watched
   //! \param event The event that occurred
   //! \return True if the event was handled, false otherwise
   //!
   //! Handles events for radio widgets, particularly keyboard shortcuts for PTT.
   virtual bool eventFilter(QObject* watched, QEvent* event);
 
   //! \brief Sets up the contents of the widget onto the supplied parent
   //! \param p The parent widget to set up the UI on
   //!
   //! Initializes the UI components of the radio stack widget and adds them to the
   //! specified parent widget.
   void setupUi(QWidget* p);
 
   //! \brief The UI components for this widget
   //!
   //! Contains the actual UI components defined in the UI file.
   Ui::DtRadioStackWidgetUI myUI;
 
   //! \brief Data model for the entity list
   //!
   //! Stores entity data for display in the entity selection list.
   QStandardItemModel* myModel;
 
   //! \brief Proxy model for filtering the entity list
   //!
   //! Provides filtering and sorting capabilities for the entity list.
   QSortFilterProxyModel* myProxy;
 
   //! \brief The radio manager handling radio functionality
   //!
   //! Manages the underlying radio simulation functionality.
   DtVrvRadioManager* myManager;
 
   //! \brief Timer for updating signal levels
   //!
   //! Periodically triggers updates to the signal level indicators.
   QTimer* myLevelsTimer;
};
} // namespace makVrv