makRadioQt.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file makRadioQt.h
//! \ingroup vrfMakRadioQt
//! \brief Main entry point for the MAK Radio Qt module
//!
//! This file defines the initialization function for the MAK Radio Qt module,
//! which provides radio communication functionality to the VREngage environment
//! through Qt-based user interface components.
 
#pragma once
 
//! \brief Platform-specific DLL export/import declaration
//!
//! This macro defines the appropriate export/import declaration for Windows DLLs
//! and establishes proper visibility for shared libraries on other platforms.
//! It is used to properly export classes and functions from the vrfMakRadioQt library.
#ifdef _WIN32
   #ifdef vrfMakRadioQt_EXPORTS
      #define VRVRADIOQT_DLL __declspec(dllexport)
   #else
      #define VRVRADIOQT_DLL __declspec(dllimport)
   #endif
#else
   #define VRVRADIOQT_DLL
#endif
 
//! \brief Setup proper plugin export symbol
//!
//! Defines the export macro for the plugin's functions.
#define DT_DE_PLUGIN_EXPORT_MACRO VRVRADIOQT_DLL
 
//! \brief Include plugin export definitions from VRV Core
//!
//! Exports the plugin's initialization function with the proper signature.
#include <vrvCore/exportPlugin.h>
 
//! \brief Include signal library for event handling
//!
//! The signalslib provides cross-platform signal and slot functionality for event handling.
#include <vrvUtil/signalslib.h>
 
//! \brief Namespace containing functions for the MAK Radio Qt module
//!
//! This namespace encapsulates all functionality related to the MAK Radio Qt module,
//! including initialization and radio interface components.
namespace makRadioQt
{
//! \brief Initializes the MAK Radio Qt module
//! \param de The document environment providing access to application resources
//!
//! This function is called when the module is loaded, and initializes all
//! radio-related Qt components and functionality. It registers the radio widgets
//! and connects them to the radio simulation subsystem.
void init(makVrv::DtDe& de);
} // namespace makRadioQt