sarSettingsLogic.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2025 MAK Technologies
 * All rights reserved.
 *****************************************************************************/
 
//! \file sarSettingsLogic.h
//! \brief Defines the SAR settings logic component for managing SAR configuration
//! \ingroup sarClient
 
#pragma once
 
#include "sarSettingsManager.h"
#include "sarClientPlugin.h"
#include <vrvUtil/DtSignalConnectionManager.h>
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
 
//! \brief Forward declaration of the settings backup class
class DtSettingsBackup;
 
//! \brief Forward declaration of the persistence controls interface class
class DtPersistenceControlsInterface;
} // namespace makVrv
 
namespace makVre
{
//! \brief Forward declaration of the SAR settings dialog class
class DtSarSettingsDialog;
 
//! \brief Logic component for managing SAR settings
//!
//! Implements the logic behind SAR settings dialog based on the humble dialog pattern.
//! This class mediates between the user interface and the SAR settings manager,
//! handling user inputs, validating settings, and persisting configurations.
//! It connects UI signals to appropriate settings update actions.
//! \ingroup sarClient
class DT_DLL_sarClient DtSarSettingsLogic : private makVrv::DtSignalConnectionManager
{
public:
   //! \brief Constructor
   //! \param de Reference to the display element
   //! \param iFace Reference to the SAR settings dialog interface
   //! \param pIFace Reference to the persistence controls interface
   DtSarSettingsLogic(makVrv::DtDe& de, DtSarSettingsDialog& iFace, makVrv::DtPersistenceControlsInterface& pIFace);
 
   //! \brief Virtual destructor
   virtual ~DtSarSettingsLogic() override;
 
   //! \brief Updates the GUI with current settings values
   //!
   //! Retrieves current settings from the manager and forwards them to the UI controls
   virtual void sendSettingsToGui();
 
   //! \brief Handles changes to the ownship mode
   //! \param val New ownship mode value
   void slot_onOwnshipModeChanged(int val);
 
   //! \brief Handles changes to the ownship entity name
   //! \param val New entity name
   void slot_onOwnshipEntityNameChanged(const std::string& val);
 
   //! \brief Handles changes to the ownship observer name
   //! \param val New observer name
   void slot_onOwnshipObserverNameChanged(const std::string& val);
 
   //! \brief Handles changes to the ownship absolute latitude
   //! \param val New latitude value
   void slot_onOwnshipAbsoluteLatChanged(double val);
 
   //! \brief Handles changes to the ownship absolute longitude
   //! \param val New longitude value
   void slot_onOwnshipAbsoluteLonChanged(double val);
 
   //! \brief Handles changes to the ownship absolute altitude
   //! \param val New altitude value
   void slot_onOwnshipAbsoluteAltChanged(double val);
 
   //! \brief Handles changes to the target mode
   //! \param val New target mode value
   void slot_onTargetModeChanged(int val);
 
   //! \brief Handles changes to the target entity name
   //! \param val New entity name
   void slot_onTargetEntityNameChanged(const std::string& val);
 
   //! \brief Handles changes to the target sensor name
   //! \param val New sensor name
   void slot_onTargetSensorNameChanged(const std::string& val);
 
   //! \brief Handles changes to the target absolute latitude
   //! \param val New latitude value
   void slot_onTargetAbsoluteLatChanged(double val);
 
   //! \brief Handles changes to the target absolute longitude
   //! \param val New longitude value
   void slot_onTargetAbsoluteLonChanged(double val);
 
   //! \brief Handles changes to the target absolute altitude
   //! \param val New altitude value
   void slot_onTargetAbsoluteAltChanged(double val);
 
   //! \brief Handles changes to the image X size
   //! \param val New X size value
   void slot_onImageSizeXChanged(int val);
 
   //! \brief Handles changes to the image Y size
   //! \param val New Y size value
   void slot_onImageSizeYChanged(int val);
 
   //! \brief Handles changes to the image rotation
   //! \param val New rotation value
   void slot_onImageRotationChanged(int val);
 
   //! \brief Handles changes to the image format
   //! \param val New format index
   void slot_onImageFormatChanged(int val);
 
   //! \brief Handles changes to the image data type
   //! \param val New data type index
   void slot_onImageDataTypeChanged(int val);
 
   //! \brief Handles changes to the sensor to use
   //! \param val New sensor name
   void slot_onSensorToUseChanged(const std::string& val);
 
   //! \brief Handles changes to the save on server setting
   //! \param val New save on server state
   void slot_onSaveOnServerChanged(bool val);
 
   //! \brief Handles changes to the server save path
   //! \param val New save path
   void slot_onServerSavePathChanged(const std::string& val);
 
   //! \brief Handles changes to the radar power
   //! \param val New power value
   void slot_onPowerChanged(double val);
 
   //! \brief Handles changes to the downrange
   //! \param val New downrange value
   void slot_onDownrangeChanged(double val);
 
   //! \brief Handles changes to the crossrange
   //! \param val New crossrange value
   void slot_onCrossrangeChanged(double val);
 
   //! \brief Handles changes to the server IP address
   //! \param val New IP address
   void slot_onServerIpChanged(const std::string& val);
 
   //! \brief Handles changes to the server port
   //! \param val New port number
   void slot_onServerPortChanged(int val);
 
   //! \brief Handles changes to the open SAR response window setting
   //! \param val New open response window state
   void slot_onOpenSarResponseWindowChanged(bool val);
 
   //! \brief Handles the reset connection button press
   void slot_onResetConnectionButtonPressed();
 
   //! \name Persistence Slots
   //! @{
 
   //! \brief Handles import button press
   //!
   //! Initiates the settings import process
   virtual void on_import();
 
   //! \brief Handles export button press
   //!
   //! Initiates the settings export process
   virtual void on_export();
 
   //! \brief Handles the selection of an import file path
   //! \param filePath Path to the file to import settings from
   virtual void on_importFilePathChosen(const std::string& filePath);
 
   //! \brief Handles the selection of an export file path
   //! \param filePath Path to the file to export settings to
   virtual void on_exportFilePathChosen(const std::string& filePath);
   //! @}
 
   //! \brief Called when settings have been restored
   //! \param b Pointer to the settings backup that was restored
   //!
   //! Updates the GUI when settings have been restored from backup
   virtual void settingsRestored(const makVrv::DtSettingsBackup* b);
 
   //! \brief Handles changes to the connection status
   //! \param val New connection status
   virtual void slot_onIsConnectedChanged(bool val);
 
   //! \brief Handles changes to the list of valid ownship entities
   //! \param validEntities List of valid entity names for ownship
   virtual void slot_onValidOwnshipEntitiesChanged(const std::vector<std::string>& validEntities);
 
   //! \brief Handles changes to the list of valid target entities
   //! \param validEntities List of valid entity names for target
   virtual void slot_onValidTargetEntitiesChanged(const std::vector<std::string>& validEntities);
 
   //! \brief Handles changes to the list of valid observers
   //! \param validObservers List of valid observer names
   virtual void slot_onValidObserversChanged(const std::vector<std::string>& validObservers);
 
   //! \brief Handles changes to the list of valid target sensors
   //! \param validSensors List of valid sensor names for target
   virtual void slot_onValidTargetSensorsChanged(const std::vector<std::string>& validSensors);
 
   //! \brief Handles changes to the settings validity state
   //! \param valid Whether the current settings are valid
   //! \param tooltip Tooltip text explaining validation issues if invalid
   virtual void slot_onSettingsValidChanged(bool valid, const std::string& tooltip);
 
protected:
   //! \brief Reference to the display element
   makVrv::DtDe& myDe;
 
   //! \brief Reference to the SAR settings dialog interface
   DtSarSettingsDialog& myInterface;
 
   //! \brief Reference to the persistence controls interface
   makVrv::DtPersistenceControlsInterface& myPersistenceInterface;
};
} // namespace makVre