sarSettingsInterface.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2025 MAK Technologies
 * All rights reserved.
 *****************************************************************************/
 
//! \file sarSettingsInterface.h
//! \brief Defines the SAR settings interface for communicating with SAR settings components
//! \ingroup sarClient
 
#pragma once
 
#include "sarSettingsRecord.h"
 
namespace makVrv
{
//! \brief Interface for SAR settings components based on the humble dialog pattern
//!
//! This interface defines the communication contract between SAR settings UI
//! and the underlying logic. It provides pure virtual setter methods for all
//! SAR settings properties and signals for notifying about property changes.
//! Components implementing this interface can receive settings updates and
//! emit change notifications.
//! \ingroup sarClient
class DT_DLL_sarClient DtSarSettingsInterface
{
public:
   //! \brief Sets the ownship mode
   //! \param val Mode value (typically 0=Entity, 1=Absolute Position)
   virtual void setOwnshipMode(int val) = 0;
 
   //! \brief Sets the ownship observer name
   //! \param val Observer name for the ownship
   virtual void setOwnshipObserverName(const std::string& val) = 0;
 
   //! \brief Sets the ownship entity name
   //! \param val Entity name for the ownship
   virtual void setOwnshipEntityName(const std::string& val) = 0;
 
   //! \brief Sets the ownship absolute position X coordinate
   //! \param val X coordinate value (typically longitude)
   virtual void setOwnshipAbsolutePositionX(double val) = 0;
 
   //! \brief Sets the ownship absolute position Y coordinate
   //! \param val Y coordinate value (typically latitude)
   virtual void setOwnshipAbsolutePositionY(double val) = 0;
 
   //! \brief Sets the ownship absolute position Z coordinate
   //! \param val Z coordinate value (typically altitude)
   virtual void setOwnshipAbsolutePositionZ(double val) = 0;
 
   //! \brief Sets the target mode
   //! \param val Mode value (typically 0=Entity, 1=Absolute Position)
   virtual void setTargetMode(int val) = 0;
 
   //! \brief Sets the target entity name
   //! \param val Entity name for the target
   virtual void setTargetEntityName(const std::string& val) = 0;
 
   //! \brief Sets the target sensor name
   //! \param val Sensor name for the target
   virtual void setTargetSensorName(const std::string& val) = 0;
 
   //! \brief Sets the target absolute position X coordinate
   //! \param val X coordinate value (typically longitude)
   virtual void setTargetAbsolutePositionX(double val) = 0;
 
   //! \brief Sets the target absolute position Y coordinate
   //! \param val Y coordinate value (typically latitude)
   virtual void setTargetAbsolutePositionY(double val) = 0;
 
   //! \brief Sets the target absolute position Z coordinate
   //! \param val Z coordinate value (typically altitude)
   virtual void setTargetAbsolutePositionZ(double val) = 0;
 
   //! \brief Sets the image X dimension (width)
   //! \param val Width in pixels
   virtual void setImageSizeX(int val) = 0;
 
   //! \brief Sets the image Y dimension (height)
   //! \param val Height in pixels
   virtual void setImageSizeY(int val) = 0;
 
   //! \brief Sets the image rotation
   //! \param val Rotation angle in degrees
   virtual void setImageRotation(int val) = 0;
 
   //! \brief Sets the image format
   //! \param val Format value (index into available formats)
   virtual void setImageFormat(int val) = 0;
 
   //! \brief Sets the image data type
   //! \param val Data type value (index into available data types)
   virtual void setImageDataType(int val) = 0;
 
   //! \brief Sets the sensor to use
   //! \param val Sensor index value
   virtual void setSensorToUse(int val) = 0;
 
   //! \brief Sets whether to save images on the RadarFx server
   //! \param val True to save on server, false otherwise
   virtual void setSaveOnServer(bool val) = 0;
 
   //! \brief Sets the server save path
   //! \param val Path on server where images will be saved
   virtual void setServerSavePath(const std::string& val) = 0;
 
   //! \brief Sets the radar power level
   //! \param val Power level value
   virtual void setPower(double val) = 0;
 
   //! \brief Sets the downrange (distance in direction of aircraft heading)
   //! \param val Downrange value in meters
   virtual void setDownrange(double val) = 0;
 
   //! \brief Sets the crossrange (distance perpendicular to aircraft heading)
   //! \param val Crossrange value in meters
   virtual void setCrossrange(double val) = 0;
 
   //! \brief Sets the RadarFx server IP address
   //! \param val IP address as a string
   virtual void setServerIp(const std::string& val) = 0;
 
   //! \brief Sets the RadarFx server port number
   //! \param val Port number
   virtual void setServerPort(int val) = 0;
 
   //! \brief Sets whether to automatically open the SAR response window
   //! \param val True to open window, false otherwise
   virtual void setOpenSarResponseWindow(bool val) = 0;
 
   //! \brief Signal emitted when ownship mode changes
   boost::signalslib::signal<void(makVre::DtSarSettingsRecord::OwnshipMode)> signal_ownshipModeChanged;
 
   //! \brief Signal emitted when ownship observer name changes
   boost::signalslib::signal<void(std::string)> signal_ownshipObserverNameChanged;
 
   //! \brief Signal emitted when ownship entity name changes
   boost::signalslib::signal<void(std::string)> signal_ownshipEntityNameChanged;
 
   //! \brief Signal emitted when ownship X position changes
   boost::signalslib::signal<void(double)> signal_ownshipAbsoluteLocationXChanged;
 
   //! \brief Signal emitted when ownship Y position changes
   boost::signalslib::signal<void(double)> signal_ownshipAbsoluteLocationYChanged;
 
   //! \brief Signal emitted when ownship Z position changes
   boost::signalslib::signal<void(double)> signal_ownshipAbsoluteLocationZChanged;
 
   //! \brief Signal emitted when target mode changes
   boost::signalslib::signal<void(makVre::DtSarSettingsRecord::TargetMode)> signal_targetModeChanged;
 
   //! \brief Signal emitted when target entity name changes
   boost::signalslib::signal<void(std::string)> signal_targetEntityNameChanged;
 
   //! \brief Signal emitted when target sensor name changes
   boost::signalslib::signal<void(std::string)> signal_targetSensorNameChanged;
 
   //! \brief Signal emitted when target X position changes
   boost::signalslib::signal<void(double)> signal_targetAbsoluteLocationXChanged;
 
   //! \brief Signal emitted when target Y position changes
   boost::signalslib::signal<void(double)> signal_targetAbsoluteLocationYChanged;
 
   //! \brief Signal emitted when target Z position changes
   boost::signalslib::signal<void(double)> signal_targetAbsoluteLocationZChanged;
 
   //! \brief Signal emitted when image X size changes
   boost::signalslib::signal<void(int)> signal_imageSizeXChanged;
 
   //! \brief Signal emitted when image Y size changes
   boost::signalslib::signal<void(int)> signal_imageSizeYChanged;
 
   //! \brief Signal emitted when image rotation changes
   boost::signalslib::signal<void(int)> signal_imageRotationChanged;
 
   //! \brief Signal emitted when image format changes
   boost::signalslib::signal<void(int)> signal_imageFormatChanged;
 
   //! \brief Signal emitted when image data type changes
   boost::signalslib::signal<void(int)> signal_imageDataTypeChanged;
 
   //! \brief Signal emitted when sensor to use changes
   boost::signalslib::signal<void(std::string)> signal_sensorToUseChanged;
 
   //! \brief Signal emitted when save on server setting changes
   boost::signalslib::signal<void(bool)> signal_saveOnServerChanged;
 
   //! \brief Signal emitted when server save path changes
   boost::signalslib::signal<void(std::string)> signal_serverSavePathChanged;
 
   //! \brief Signal emitted when radar power changes
   boost::signalslib::signal<void(double)> signal_powerChanged;
 
   //! \brief Signal emitted when downrange changes
   boost::signalslib::signal<void(double)> signal_downrangeChanged;
 
   //! \brief Signal emitted when crossrange changes
   boost::signalslib::signal<void(double)> signal_crossrangeChanged;
 
   //! \brief Signal emitted when server IP changes
   boost::signalslib::signal<void(std::string)> signal_serverIpChanged;
 
   //! \brief Signal emitted when server port changes
   boost::signalslib::signal<void(int)> signal_serverPortChanged;
 
   //! \brief Signal emitted when open response window setting changes
   boost::signalslib::signal<void(bool)> signal_openSarResponseWindowChanged;
 
   //! \brief Signal emitted when reset connection button is pressed
   boost::signalslib::signal<void()> signal_resetConnectionButtonPressed;
};
 
} // namespace makVrv