vreVrfMessageInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreVrfMessageInterface.h
//! \brief Defines DtVreVrfMsgInterface for handling VR-Forces message interactions
//!
//! This interface manages message communication with VR-Forces, providing factory
//! registration for various message types and handling of incoming data events.
 
#pragma once
 
#include "export.h"
 
#include <vrfMsgTransport/vrfMessageInterface.h>
#include <vrfmsgs/defaultVrfObjectMessageFactory.h>
#include <vrftasks/defaultSimTaskFactory.h>
#include <vrftasks/defaultSimReportFactory.h>
#include <vrftasks/defaultSetDataRequestFactory.h>
#include <vrfutil/defaultCondExprFactory.h>
#include <vrfplan/defaultStatementFactory.h>
 
 
//! \brief Interface for handling VR-Forces message interactions in the VREngage framework
//!
//! DtVreVrfMsgInterface extends the base VR-Forces message interface to provide
//! VREngage-specific message handling functionality. It initializes various factory
//! objects for creating message types, tasks, reports, and other simulation elements.
class VRL_DLL DtVreVrfMsgInterface : public DtVrfMessageInterface
{
public:
   //! \brief Constructor for the VR-Forces message interface
   //! \param exConn Pointer to the communication manager to use
   //! \param useDefaultInterfaceFactory If true, uses the default interface factory
   DtVreVrfMsgInterface(DtCommunicationManager* exConn, bool useDefaultInterfaceFactory = true);
 
   //! \brief Processes an incoming VR-Forces data event
   //! \param dataInter Pointer to the data event to process
   //! \return True if the message was successfully handled, false otherwise
   //!
   //! This method is overridden to handle VR-Forces data interactions.
   //! Currently, it simply delegates to the parent class implementation.
   virtual bool receiveMessage(const makVrfEvents::DtDataEvent* dataInter) override;
 
   //! \brief Initializes the message interface and registers message factory objects
   //! \return True if initialization was successful, false otherwise
   //!
   //! This method sets up the factory objects for various message types and simulation elements.
   //! It can be extended to register custom message types as needed.
   virtual bool init() override;
 
protected:
   //! \brief Default constructor - not implemented
   //!
   //! Declared but not implemented to prevent usage.
   DtVreVrfMsgInterface();
 
protected:
   //! \brief Factory for creating VR-Forces object messages
   DtDefaultVrfObjectMessageFactory myRadioMsgFact;
 
   //! \brief Factory for creating condition expressions
   DtDefaultCondExprFactory myCondExprFact;
 
   //! \brief Factory for creating simulation statements
   DtDefaultStatementFactory myStmtFact;
 
   //! \brief Factory for creating simulation reports
   DtDefaultSimReportFactory myReportFact;
 
   //! \brief Factory for creating simulation tasks
   DtDefaultSimTaskFactory myTaskFact;
 
   //! \brief Factory for creating set data requests
   DtDefaultSetDataRequestFactory mySetDataFact;
};