vreSelectConnectionPageDriverHLA.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSelectConnectionPageDriverHLA.h
//! \brief Defines the HLA-specific connection driver for VR-Engage
//!
//! This file contains the DtVreSelectConnectionPageDriverHLA class which provides
//! the implementation of a connection driver for the High-Level Architecture (HLA)
//! protocol. It exposes HLA-specific configuration properties to the connection
//! selection UI and handles the persistence of HLA federation and federate settings.
 
#pragma once
 
#include <vrePlayerStation/export.h>
#include <vrePlayerStation/vreSelectConnectionPageDriver.h>
 
#include <QObject>
 
namespace makVre
{
//! \brief HLA protocol connection driver for the connection selection UI
//!
//! DtVreSelectConnectionPageDriverHLA is a specialized connection driver for
//! the High-Level Architecture (HLA) protocol. It provides properties and methods
//! for configuring HLA-specific connection settings such as federation name,
//! federate name, FOM modules, and various behavioral flags. This class exposes
//! these properties to QML for the connection selection UI and manages their
//! persistence in the application's configuration.
class PLAYERSTATION_DLL DtVreSelectConnectionPageDriverHLA : public DtVreSelectConnectionPageDriver
{
   Q_OBJECT;
 
   Q_PROPERTY(QString federationName READ getFederationName WRITE setFederationName NOTIFY federationNameChanged);
   Q_PROPERTY(QString fedFileName READ getFedFileName WRITE setFedFileName NOTIFY fedFileNameChanged);
   Q_PROPERTY(QString federateType READ getFederateType WRITE setFederateType NOTIFY federateTypeChanged);
   Q_PROPERTY(QString federateName READ getFederateName WRITE setFederateName NOTIFY federateNameChanged);
   Q_PROPERTY(QString fomMapperLib READ getFomMapperLib WRITE setFomMapperLib NOTIFY fomMapperLibChanged);
   Q_PROPERTY(bool useAbsoluteTimeStamps READ getUseAbsoluteTimeStamps WRITE setUseAbsoluteTimeStamps NOTIFY
         useAbsoluteTimeStampsChanged);
   Q_PROPERTY(
      QString fomMapperInitData READ getFomMapperInitData WRITE setFomMapperInitData NOTIFY fomMapperInitDataChanged);
   Q_PROPERTY(int siteId READ getSiteId WRITE setSiteId NOTIFY siteIdChanged);
   Q_PROPERTY(int appNumber READ getAppNumber WRITE setAppNumber NOTIFY appNumberChanged);
   Q_PROPERTY(qreal rprFomVersion READ getRprFomVersion WRITE setRprFomVersion NOTIFY rprFomVersionChanged);
   Q_PROPERTY(int rprFomRevision READ getRprFomRevision WRITE setRprFomRevision NOTIFY rprFomRevisionChanged);
   Q_PROPERTY(bool useAdvisories READ getUseAdvisories WRITE setUseAdvisories NOTIFY useAdvisoriesChanged);
   Q_PROPERTY(bool useGeographicDdm READ getUseGeographicDdm WRITE setUseGeographicDdm NOTIFY useGeographicDdmChanged);
   Q_PROPERTY(bool publishObservers READ getPublishObservers WRITE setPublishObservers NOTIFY publishObserversChanged);
   Q_PROPERTY(
      bool viewControlEnabled READ getViewControlEnabled WRITE setViewControlEnabled NOTIFY viewControlEnabledChanged);
   Q_PROPERTY(bool overrideGlobalViewControl READ getOverrideGlobalViewControl WRITE setOverrideGlobalViewControl NOTIFY
         overrideGlobalViewControlChanged);
   Q_PROPERTY(bool useTopoForFlatEarthVectorConversion READ getUseTopoForFlatEarthVectorConversion WRITE
         setUseTopoForFlatEarthVectorConversion NOTIFY useTopoForFlatEarthVectorConversionChanged);
   Q_PROPERTY(QStringList fomModules READ getFomModules WRITE setFomModules NOTIFY fomModulesChanged);
   Q_PROPERTY(QString localSettingsDesignator READ getLocalSettingsDesignator WRITE setLocalSettingsDesignator NOTIFY
         localSettingsDesignatorChanged);
   Q_PROPERTY(qreal connectionFrameTime READ getConnectionFrameTime WRITE setConnectionFrameTime NOTIFY
         connectionFrameTimeChanged);
 
public:
   //! \brief Constructor
   //! \param parent Optional parent QObject for memory management
   //!
   //! Creates a new HLA connection driver with default property values.
   explicit DtVreSelectConnectionPageDriverHLA(QObject* parent = nullptr);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the HLA connection driver.
   virtual ~DtVreSelectConnectionPageDriverHLA() override;
 
   //! \brief Sets driver data from a message
   //! \param msg Pointer to the message containing HLA driver configuration data
   //!
   //! Parses and applies HLA-specific configuration data from a message.
   //! This is typically called when loading saved configurations or
   //! receiving updates from the network subsystem.
   virtual void setData(makVre::DtVreMessage* msg) override;
 
   //! \brief Saves the current HLA driver configuration
   //!
   //! Collects the current HLA configuration properties and sends them
   //! to the network subsystem for persistence and activation. This is
   //! typically called when the user confirms changes to the connection settings.
   virtual Q_INVOKABLE void save() override;
 
   QString getFederationName() const;
   QString getFedFileName() const;
   QString getFederateType() const;
   QString getFederateName() const;
   QString getFomMapperLib() const;
   bool getUseAbsoluteTimeStamps() const;
   QString getFomMapperInitData() const;
   int getSiteId() const;
   int getAppNumber() const;
   qreal getRprFomVersion() const;
   int getRprFomRevision() const;
   bool getUseAdvisories() const;
   bool getUseGeographicDdm() const;
   bool getPublishObservers() const;
   bool getViewControlEnabled() const;
   bool getOverrideGlobalViewControl() const;
   bool getUseTopoForFlatEarthVectorConversion() const;
   QStringList getFomModules() const;
   QString getLocalSettingsDesignator() const;
   qreal getConnectionFrameTime() const;
 
public slots:
   void setFederationName(QString);
   void setFedFileName(QString);
   void setFederateType(QString);
   void setFederateName(QString);
   void setFomMapperLib(QString);
   void setUseAbsoluteTimeStamps(bool);
   void setFomMapperInitData(QString);
   void setSiteId(int);
   void setAppNumber(int);
   void setRprFomVersion(qreal);
   void setRprFomRevision(int);
   void setUseAdvisories(bool);
   void setUseGeographicDdm(bool);
   void setPublishObservers(bool);
   void setViewControlEnabled(bool);
   void setOverrideGlobalViewControl(bool);
   void setUseTopoForFlatEarthVectorConversion(bool);
   void setFomModules(QStringList);
   void setLocalSettingsDesignator(QString);
   void setConnectionFrameTime(qreal);
 
signals:
   void federationNameChanged(QString);
   void fedFileNameChanged(QString);
   void federateTypeChanged(QString);
   void federateNameChanged(QString);
   void fomMapperLibChanged(QString);
   void useAbsoluteTimeStampsChanged(bool);
   void fomMapperInitDataChanged(QString);
   void siteIdChanged(int);
   void appNumberChanged(int);
   void rprFomVersionChanged(qreal);
   void rprFomRevisionChanged(int);
   void useAdvisoriesChanged(bool);
   void useGeographicDdmChanged(bool);
   void publishObserversChanged(bool);
   void viewControlEnabledChanged(bool);
   void overrideGlobalViewControlChanged(bool);
   void useTopoForFlatEarthVectorConversionChanged(bool);
   void fomModulesChanged(QStringList);
   void localSettingsDesignatorChanged(QString);
   void connectionFrameTimeChanged(qreal);
 
protected:
   //! \brief Name of the HLA federation to join
   QString myFederationName;
 
   //! \brief Path to the Federation Execution Data (FED) file
   QString myFedFileName;
 
   //! \brief Type of the federate in the federation
   QString myFederateType;
 
   //! \brief Name of this federate in the federation
   QString myFederateName;
 
   //! \brief Library to use for FOM mapping
   QString myFomMapperLib;
 
   //! \brief Flag to use absolute timestamps in updates
   bool myUseAbsoluteTimeStamps;
 
   //! \brief Initialization data for the FOM mapper
   QString myFomMapperInitData;
 
   //! \brief Site ID for HLA
   int mySiteId;
 
   //! \brief Application number for HLA
   int myAppNumber;
 
   //! \brief RPR FOM version number
   qreal myRprFomVersion;
 
   //! \brief RPR FOM revision number
   int myRprFomRevision;
 
   //! \brief Flag to use HLA advisories
   bool myUseAdvisories;
 
   //! \brief Flag to use geographic DDM
   bool myUseGeographicDdm;
 
   //! \brief Flag to publish observer entities
   bool myPublishObservers;
 
   //! \brief Flag to enable view control
   bool myViewControlEnabled;
 
   //! \brief Flag to override global view control settings
   bool myOverrideGlobalViewControl;
 
   //! \brief Flag to use topographic data for flat earth vector conversion
   bool myUseTopoForFlatEarthVectorConversion;
 
   //! \brief List of FOM modules to load
   QStringList myFomModules;
 
   //! \brief Local settings designator for RTI configuration
   QString myLocalSettingsDesignator;
 
   //! \brief Frame time for connections in seconds
   qreal myConnectionFrameTime;
};
} // namespace makVre