vreRtdBackendLibCommon.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRtdBackendLibCommon.h
//! \ingroup vreVrfRtd
//! \brief Common definitions for the RTD backend library
//!
//! This file provides common preprocessor macros, export declarations, and includes
//! that are used throughout the VREngage RTD (Real-Time Dynamics) backend libraries.
//! It establishes the export/import declarations for DLL boundaries and common
//! utility macros used by RTD components.
 
#pragma once
 
//! \brief Platform-specific DLL export/import declarations
//!
//! These macros define the appropriate export/import declarations for Windows DLLs
//! and establish proper visibility for shared libraries on Linux platforms.
#ifdef WIN32
   #ifdef RTD_SHARED_BACKENDLIB_DLL
      #ifdef RTD_VRF_BACKEND_PLUGIN_EXPORTS
         #define RTD_VRF_BACKEND_PLUGIN_EXPORT _declspec(dllexport)
      #else
         #define RTD_VRF_BACKEND_PLUGIN_EXPORT _declspec(dllimport)
      #endif
      //    Disable warnings: non dll-interface class 'Dt...' used as base for dll-interface class 'RtdVrf::...'
      //    This is perfectly OK in this scenario.
      #pragma warning(disable : 4275)
   #else
      #define RTD_VRF_BACKEND_PLUGIN_EXPORT
   #endif
#elif defined(__linux)
   #define RTD_VRF_BACKEND_PLUGIN_EXPORT
#endif
 
//! \brief Macro to declare unimplemented copy constructor and assignment operator
//! \param className The name of the class to declare these functions for
//!
//! This macro declares a private, unimplemented copy constructor and assignment operator
//! for the specified class, preventing implicit copying and assignment. This is used
//! for classes that should not be copied, especially components and repositories.
#define UNIMPLEMENTED_COPYCTOR_AND_ASSIGNMENT_OPERATOR(className)                                                      \
   className(const className& orig);                                                                                   \
   const className& operator=(const className& orig);
 
//! \brief Include helper for managing warning configurations
#include <vreVrfRtdobjparam/RTDVRFConfigWarnsForExternalIncludes.h>
 
//! \brief Configure warnings for external includes
//!
//! Temporarily adjusts compiler warning settings for external includes.
//! Warnings are restored after the includes with #pragma warning(pop).
RTDVRFConfigWarnsForExternalIncludes()
#include <vrftasks/radioMessageTypes.h>
#pragma warning(pop)
 
//! \brief Defines the minimum user radio message type
//!
//! This macro establishes the minimum value for user-defined radio message types,
//! ensuring they don't conflict with system-defined message types.
#define RTD_MIN_USER_RADIO_MESSAGE_TYPE MIN_USER_INTERFACE_MESSAGE_TYPE
 
//! \brief Include RTD common definitions
//!
//! Includes common types, constants, and utility functions used by the RTD system.
#include <RTD/Common.h>