vreVrfPlugin.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfPlugin.h
//! \ingroup vreVrfSimProtocolDependentPlugin
//! \brief Main entry point for the VREngage protocol-dependent simulation plugin
//!
//! This file defines the initialization, post-initialization, and unload functions
//! for the VREngage protocol-dependent simulation plugin, which extends the base VRF
//! simulation with protocol-specific (DIS or HLA) functionality for VREngage.
 
#pragma once
#include <vreVrfSimProtocolDependentPlugin/export.h>
 
//! \brief Protocol-specific namespace and identifier definitions
//!
//! Defines the appropriate protocol namespace and protocol identifier based on
//! which protocol variant (DIS or HLA1516e) is being built. These definitions
//! determine the actual namespace for the plugin functions and are used to identify
//! the protocol being used throughout the code.
#if defined(DtDIS)
   //! \brief Namespace for DIS protocol variant
   #define VRE_VRF_PROTOCOL_NAMESPACE DtVreVrfSimPluginDIS
   //! \brief Protocol identifier string for DIS
   #define VRE_VRF_PROTOCOL "DIS"
#elif defined(DtHLA)
   #if defined(DtHLA_1516)
      #if defined(DtHLA_4)
         //! \brief Protocol identifier string for HLA4
         #define VRE_VRF_PROTOCOL_NAMESPACE DtVreVrfSimPluginHLA4
         //! \brief Protocol identifier string for HLA4
         #define VRE_VRF_PROTOCOL "HLA4"
      #elif defined(DtHLA_1516_EVOLVED)
         //! \brief Namespace for HLA1516e protocol variant
         #define VRE_VRF_PROTOCOL_NAMESPACE DtVreVrfSimPluginHLA1516e
         //! \brief Protocol identifier string for HLA1516e
         #define VRE_VRF_PROTOCOL "HLA1516e"
      #else
         #define VRE_VRF_PROTOCOL_NAMESPACE DtVreVrfSimPluginHLA1516
         #define VRE_VRF_PROTOCOL "HLA1516"
      #endif
   #else
      #define VRE_VRF_PROTOCOL_NAMESPACE DtVreVrfSimPluginHLA13
      #define VRE_VRF_PROTOCOL "HLA13"
   #endif
#endif
 
#include <vrfutil/vrfPluginInformation.h>
 
class DtCgf;
 
namespace makVre
{
//! \brief Namespace containing functions for the VREngage protocol-dependent simulation plugin
//!
//! This namespace contains functions to initialize, post-initialize, and unload
//! the VREngage protocol-dependent simulation plugin, as well as provide information
//! about the plugin. The actual namespace (DtVreVrfSimPluginDIS or DtVreVrfSimPluginHLA1516e)
//! is determined by the protocol-specific configuration.
namespace VRE_VRF_PROTOCOL_NAMESPACE
{
//! \brief Initializes the VREngage protocol-dependent simulation plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//! \return True if initialization was successful, false otherwise
//!
//! This function is called during the plugin initialization phase. It registers
//! protocol-specific simulation components, network interfaces, and message handlers
//! with the CGF engine for the appropriate protocol (DIS or HLA).
VREVRFSIMPROTOCOLDEPENDENTPLUGIN_DLL bool DtInitializeVreVrfPlugin(DtCgf* cgf);
 
//! \brief Performs post-initialization tasks for the protocol-dependent plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//! \return True if post-initialization was successful, false otherwise
//!
//! This function is called after all plugins have been initialized. It performs
//! protocol-specific tasks that depend on other plugins being already initialized,
//! such as establishing connections between protocol handlers and simulation components.
VREVRFSIMPROTOCOLDEPENDENTPLUGIN_DLL bool DtPostInitializeVreVrfPlugin(DtCgf* cgf);
 
//! \brief Unloads the VREngage protocol-dependent simulation plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//!
//! This function is called when the plugin is being unloaded. It unregisters
//! protocol-specific components and performs cleanup of any resources allocated
//! during initialization and operation for the particular protocol variant.
VREVRFSIMPROTOCOLDEPENDENTPLUGIN_DLL void DtUnloadVreVrfPlugin(DtCgf* cgf);
 
//! \brief Provides information about the protocol-dependent simulation plugin
//! \param info Reference to a structure to be filled with plugin information
//!
//! This function fills the provided structure with information about the
//! VREngage protocol-dependent simulation plugin, including its name, version,
//! dependencies, and protocol-specific capabilities.
VREVRFSIMPROTOCOLDEPENDENTPLUGIN_DLL void DtVreVrfPluginInformation(DtVrfPluginInformation& info);
} // namespace VRE_VRF_PROTOCOL_NAMESPACE
} // namespace makVre