radioWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file radioWidget.h
//! \ingroup vrfMakRadioQt
//! \brief Individual radio control widget for VREngage
//!
//! This file defines the DtRadioWidget class, which provides a user interface
//! for controlling individual radio channels in the VREngage environment. It includes
//! controls for power, channel selection, volume, and push-to-talk functionality.
 
#pragma once
 
#include <vrvUtil/signalslib.h>
 
#include "radioWidget.hpp"
 
#include <QtWidgets/QWidget>
 
#include <string>
#include <vector>
 
namespace makRadio
{
class DtRadio;
}
 
namespace makVrv
{
class DtRadioStackWidget;
class DtRadioEventProcessor;
 
//! \brief Individual radio control widget for VREngage
//!
//! This widget provides a user interface for controlling a single radio channel
//! in the VREngage environment. It includes controls for power, channel selection,
//! volume adjustment, push-to-talk functionality, and jamming capabilities.
class DtRadioWidget : public QWidget
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param radio Pointer to the radio object this widget controls
   //! \param parent Pointer to the parent radio stack widget
   //!
   //! Creates a new radio widget to control the specified radio object
   //! within the specified parent stack widget.
   DtRadioWidget(makRadio::DtRadio* radio, DtRadioStackWidget* parent);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the radio widget.
   virtual ~DtRadioWidget();
 
   //! \brief Updates the GUI to reflect the current radio state
   //!
   //! Synchronizes all controls in this widget to match the current
   //! state of the underlying radio object. This includes power state,
   //! channel, volume, and mute settings.
   virtual void updateGuiFromRadio();
 
   //! \brief Gets the radio object controlled by this widget
   //! \return Pointer to the radio object
   //!
   //! Returns a pointer to the radio object this widget controls.
   virtual makRadio::DtRadio* radio();
 
public slots:
   //! \brief Slot called when the power state changes
   //! \param state The new power state (true = on, false = off)
   //!
   //! Updates the radio's power state when the power button is toggled.
   virtual void powerChanged(bool state);
 
   //! \brief Slot called when the channel selection changes
   //! \param channel The new channel index
   //!
   //! Changes the radio's active channel when a new channel is selected.
   virtual void channelChanged(int channel);
 
   //! \brief Slot called when the talk button is pressed
   //!
   //! Activates transmission on this radio channel when the talk button is pressed.
   virtual void talkButtonPressed();
 
   //! \brief Slot called when the talk button is released
   //!
   //! Deactivates transmission on this radio channel when the talk button is released.
   virtual void talkButtonReleased();
 
   //! \brief Slot called when the volume setting changes
   //! \param value The new volume value
   //!
   //! Updates the volume level for this radio channel.
   virtual void volumeChanged(int value);
 
   //! \brief Slot called when the microphone mute state changes
   //! \param state The new mute state (true = muted, false = unmuted)
   //!
   //! Mutes or unmutes the microphone input for this radio channel.
   virtual void micMuteChanged(bool state);
 
   //! \brief Slot called when the speaker mute state changes
   //! \param state The new mute state (true = muted, false = unmuted)
   //!
   //! Mutes or unmutes the speaker output for this radio channel.
   virtual void speakerMuteChanged(bool state);
 
   //! \brief Slot called when the jammer state changes
   //! \param state The new jammer state (true = active, false = inactive)
   //!
   //! Activates or deactivates jamming capabilities for this radio channel.
   virtual void jammerChanged(bool state);
 
   //! \brief Updates the signal level indicators
   //!
   //! Updates the visual indicators for signal strength and activity levels.
   virtual void updateLevels();
 
protected:
   //! \brief Updates the frequency display text
   //!
   //! Updates the text display showing the current radio frequency
   //! based on the active channel.
   virtual void updateFrequencyText();
 
   //! \brief Pointer to the radio object this widget controls
   //!
   //! References the underlying radio simulation object that this widget controls.
   makRadio::DtRadio* myRadio;
 
   //! \brief Pointer to the jammer radio object
   //!
   //! References the radio object used for jamming functionality, if available.
   makRadio::DtRadio* myJammer;
 
   //! \brief Pointer to the parent radio stack widget
   //!
   //! References the parent radio stack widget that contains this radio widget.
   DtRadioStackWidget* myStack;
 
   //! \brief The UI components for this widget
   //!
   //! Contains the actual UI components defined in the UI file.
   Ui::DtRadioWidgetUI myUi;
};
} // namespace makVrv