vreSelectConnectionPageDriverDIS.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSelectConnectionPageDriverDIS.h
//! \brief Defines the DIS-specific connection driver for VR-Engage
//!
//! This file contains the DtVreSelectConnectionPageDriverDIS class which provides
//! the implementation of a connection driver for the Distributed Interactive
//! Simulation (DIS) protocol. It exposes DIS-specific configuration properties
//! to the connection selection UI and handles the persistence of DIS connection settings.
 
#pragma once
 
#include <vrePlayerStation/export.h>
#include <vrePlayerStation/vreSelectConnectionPageDriver.h>
 
#include <QObject>
 
class QQuickItem;
class QStringList;
 
namespace makVre
{
//! \brief Forward declaration of the player station application class
class DtPlayerStationApp;
 
//! \brief DIS protocol connection driver for the connection selection UI
//!
//! DtVreSelectConnectionPageDriverDIS is a specialized connection driver for
//! the Distributed Interactive Simulation (DIS) protocol. It provides properties
//! and methods for configuring DIS-specific connection settings such as network
//! addresses, port numbers, exercise IDs, 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 DtVreSelectConnectionPageDriverDIS : public DtVreSelectConnectionPageDriver
{
   Q_OBJECT;
 
   Q_PROPERTY(QString destinationAddress READ getDestinationAddress WRITE setDestinationAddress NOTIFY
         destinationAddressChanged);
   Q_PROPERTY(QString deviceAddress READ getDeviceAddress WRITE setDeviceAddress NOTIFY deviceAddressChanged);
   Q_PROPERTY(QString subnetMask READ getSubnetMask WRITE setSubnetMask NOTIFY subnetMaskChanged);
   Q_PROPERTY(QStringList multicastAddresses READ getMulticastAddresses WRITE setMulticastAddresses NOTIFY
         multicastAddressesChanged);
   Q_PROPERTY(bool overrideGlobalViewControl READ getOverrideGlobalViewControl WRITE setOverrideGlobalViewControl NOTIFY
         overrideGlobalViewControlChanged);
   Q_PROPERTY(bool publishObservers READ getPublishObservers WRITE setPublishObservers NOTIFY publishObserversChanged);
   Q_PROPERTY(bool showSelfReflect READ getShowSelfReflect WRITE setShowSelfReflect NOTIFY showSelfReflectChanged);
   Q_PROPERTY(
      bool timeoutProcessing READ getTimeoutProcessing WRITE setTimeoutProcessing NOTIFY timeoutProcessingChanged);
   Q_PROPERTY(bool useAbsoluteTimeStamps READ getUseAbsoluteTimeStamps WRITE setUseAbsoluteTimeStamps NOTIFY
         useAbsoluteTimeStampsChanged);
   Q_PROPERTY(bool useAsynchIO READ getUseAsynchIO WRITE setUseAsynchIO NOTIFY useAsynchIOChanged);
   Q_PROPERTY(bool useTopoForFlatEarthVectorConversion READ getUseTopoForFlatEarthVectorConversion WRITE
         setUseTopoForFlatEarthVectorConversion NOTIFY useTopoForFlatEarthVectorConversionChanged);
   Q_PROPERTY(
      bool viewControlEnabled READ getViewControlEnabled WRITE setViewControlEnabled NOTIFY viewControlEnabledChanged);
   Q_PROPERTY(
      int applicationNumber READ getApplicationNumber WRITE setApplicationNumber NOTIFY applicationNumberChanged);
   Q_PROPERTY(int disVersion READ getDisVersion WRITE setDisVersion NOTIFY disVersionChanged);
   Q_PROPERTY(int exerciseId READ getExerciseId WRITE setExerciseId NOTIFY exerciseIdChanged);
   Q_PROPERTY(int multicastTtl READ getMulticastTtl WRITE setMulticastTtl NOTIFY multicastTtlChanged);
   Q_PROPERTY(int port READ getPort WRITE setPort NOTIFY portChanged);
   Q_PROPERTY(
      int receiveBufferSize READ getReceiveBufferSize WRITE setReceiveBufferSize NOTIFY receiveBufferSizeChanged);
   Q_PROPERTY(int sendBufferSize READ getSendBufferSize WRITE setSendBufferSize NOTIFY sendBufferSizeChanged);
   Q_PROPERTY(int siteId READ getSiteId WRITE setSiteId NOTIFY siteIdChanged);
   Q_PROPERTY(qreal connectionFrameTime READ getConnectionFrameTime WRITE setConnectionFrameTime NOTIFY
         connectionFrameTimeChanged);
   Q_PROPERTY(qreal timeoutInterval READ getTimeoutInterval WRITE setTimeoutInterval NOTIFY timeoutIntervalChanged);
 
public:
   //! \brief Constructor
   //! \param parent Optional parent QObject for memory management
   //!
   //! Creates a new DIS connection driver with default property values.
   explicit DtVreSelectConnectionPageDriverDIS(QObject* parent = nullptr);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the DIS connection driver.
   virtual ~DtVreSelectConnectionPageDriverDIS() override;
 
   //! \brief Sets driver data from a message
   //! \param msg Pointer to the message containing DIS driver configuration data
   //!
   //! Parses and applies DIS-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 DIS driver configuration
   //!
   //! Collects the current DIS 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;
 
   virtual QString getDestinationAddress() const;
   virtual QString getDeviceAddress() const;
   virtual QString getSubnetMask() const;
   virtual QStringList getMulticastAddresses() const;
   virtual bool getOverrideGlobalViewControl() const;
   virtual bool getPublishObservers() const;
   virtual bool getShowSelfReflect() const;
   virtual bool getTimeoutProcessing() const;
   virtual bool getUseAbsoluteTimeStamps() const;
   virtual bool getUseAsynchIO() const;
   virtual bool getUseTopoForFlatEarthVectorConversion() const;
   virtual bool getViewControlEnabled() const;
   virtual int getApplicationNumber() const;
   virtual int getDisVersion() const;
   virtual int getExerciseId() const;
   virtual int getMulticastTtl() const;
   virtual int getPort() const;
   virtual int getReceiveBufferSize() const;
   virtual int getSendBufferSize() const;
   virtual int getSiteId() const;
   virtual qreal getConnectionFrameTime() const;
   virtual qreal getTimeoutInterval() const;
 
public slots:
   virtual void setDestinationAddress(QString);
   virtual void setDeviceAddress(QString);
   virtual void setSubnetMask(QString);
   virtual void setMulticastAddresses(QStringList);
   virtual void setOverrideGlobalViewControl(bool);
   virtual void setPublishObservers(bool);
   virtual void setShowSelfReflect(bool);
   virtual void setTimeoutProcessing(bool);
   virtual void setUseAbsoluteTimeStamps(bool);
   virtual void setUseAsynchIO(bool);
   virtual void setUseTopoForFlatEarthVectorConversion(bool);
   virtual void setViewControlEnabled(bool);
   virtual void setApplicationNumber(int);
   virtual void setDisVersion(int);
   virtual void setExerciseId(int);
   virtual void setMulticastTtl(int);
   virtual void setPort(int);
   virtual void setReceiveBufferSize(int);
   virtual void setSendBufferSize(int);
   virtual void setSiteId(int);
   virtual void setConnectionFrameTime(qreal);
   virtual void setTimeoutInterval(qreal);
 
signals:
   void destinationAddressChanged(QString);
   void deviceAddressChanged(QString);
   void subnetMaskChanged(QString);
   void multicastAddressesChanged(QStringList);
   void overrideGlobalViewControlChanged(bool);
   void publishObserversChanged(bool);
   void showSelfReflectChanged(bool);
   void timeoutProcessingChanged(bool);
   void useAbsoluteTimeStampsChanged(bool);
   void useAsynchIOChanged(bool);
   void useTopoForFlatEarthVectorConversionChanged(bool);
   void viewControlEnabledChanged(bool);
   void applicationNumberChanged(int);
   void disVersionChanged(int);
   void exerciseIdChanged(int);
   void multicastTtlChanged(int);
   void portChanged(int);
   void receiveBufferSizeChanged(int);
   void sendBufferSizeChanged(int);
   void siteIdChanged(int);
   void connectionFrameTimeChanged(qreal);
   void timeoutIntervalChanged(qreal);
 
protected:
   //! \brief Destination IP address for DIS packets
   QString myDestinationAddress;
 
   //! \brief Network device address to bind to
   QString myDeviceAddress;
 
   //! \brief Subnet mask for the network
   QString mySubnetMask;
 
   //! \brief List of multicast addresses to join
   QStringList myMulticastAddresses;
 
   //! \brief Flag to override global view control settings
   bool myOverrideGlobalViewControl;
 
   //! \brief Flag to publish observer entities
   bool myPublishObservers;
 
   //! \brief Flag to show self-reflections
   bool myShowSelfReflect;
 
   //! \brief Flag to enable timeout processing for entities
   bool myTimeoutProcessing;
 
   //! \brief Flag to use absolute timestamps in PDUs
   bool myUseAbsoluteTimeStamps;
 
   //! \brief Flag to use asynchronous I/O for network communications
   bool myUseAsynchIO;
 
   //! \brief Flag to use topographic data for flat earth vector conversion
   bool myUseTopoForFlatEarthVectorConversion;
 
   //! \brief Flag to enable view control PDUs
   bool myViewControlEnabled;
 
   //! \brief Application ID number for DIS
   int myApplicationNumber;
 
   //! \brief DIS protocol version
   int myDisVersion;
 
   //! \brief Exercise ID for DIS simulation
   int myExerciseId;
 
   //! \brief Time-to-live for multicast packets
   int myMulticastTtl;
 
   //! \brief UDP port number for DIS communications
   int myPort;
 
   //! \brief Size of the receive buffer in bytes
   int myReceiveBufferSize;
 
   //! \brief Size of the send buffer in bytes
   int mySendBufferSize;
 
   //! \brief Site ID for DIS
   int mySiteId;
 
   //! \brief Frame time for connections in seconds
   qreal myConnectionFrameTime;
 
   //! \brief Timeout interval for entities in seconds
   qreal myTimeoutInterval;
};
} // namespace makVre