setRadarSettings.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file setRadarSettings.h
//! \ingroup vreVrfMessages
//! \brief Defines a request message for configuring radar settings
//!
//! This file contains the DtSetRadarSettingsRequest class which allows runtime
//! modification of radar system configuration parameters such as radar mode,
//! antenna properties, and target designations.
 
#pragma once
 
#include "export.h"
 
#include <vrftasks/setDataRequest.h>
#include <vlpi/netStructs.h>
#include <readerWriter/rwReal.h>
 
//! \brief Request message for configuring radar settings
//!
//! The DtSetRadarSettingsRequest class is used to set radar configuration properties
//! including mode, antenna parameters, and target designations. This allows runtime
//! control over radar system behavior and performance characteristics.
 
//! \brief Menu item identifier for radar setting operations
const char DtSetRadarSettingsMenuItemIdName[] = "DtSetRadarSettingsMenuItem";
 
class VRFMESSAGES_DLL DtSetRadarSettingsRequest : public DtSetDataRequest
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar settings request.
   DtSetRadarSettingsRequest();
 
   //! \brief Constructor with write name
   //! \param writeName The name to identify this request
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! If you have a request 'put' itself, the writeName will preface it.
   DtSetRadarSettingsRequest(const DtString& writeName, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor with new name
   //! \param writeName The name to identify this request
   //! \param orig The radar settings request to copy from
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! Creates a new radar settings request by copying an existing one.
   DtSetRadarSettingsRequest(
      const DtString& writeName, const DtSetRadarSettingsRequest& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The radar settings request to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another radar settings request into this one.
   const DtSetRadarSettingsRequest& operator=(const DtSetRadarSettingsRequest& orig);
 
   //! \brief Virtual destructor
   virtual ~DtSetRadarSettingsRequest() override;
 
   //! \brief Gets the request message type
   //! \return The message type identifier
   //!
   //! Returns DtSetRadarSettingsType as defined in vreVrfMessageTypes.h.
   virtual const DtSetMessageType& type() const override;
 
   //! \brief Creates a copy of this request
   //! \param name The name to assign to the new request
   //! \param parentRegistry Optional reader-writer registry for serialization
   //! \return Pointer to the newly created request
   //!
   //! Creates a dynamically allocated copy of this request with a new name.
   virtual DtSetDataRequest* clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets a readable string representation of this request
   //! \return String representation of the request
   //!
   //! Returns a human-readable representation of the request contents.
   virtual DtString stringRep() const override;
 
   //! \brief Gets the radar mode
   //! \return The radar mode string
   //!
   //! Returns the operational mode of the radar (e.g., "Search", "Track").
   virtual DtString mode() const;
 
   //! \brief Checks if a radar mode is specified
   //! \return True if mode is specified, false otherwise
   virtual bool modeSpecified() const;
 
   //! \brief Sets the radar mode
   //! \param value The mode string to set
   virtual void setMode(const DtString& value);
 
   //! \brief Gets the radar submode
   //! \return The radar submode string
   //!
   //! Returns the operational submode within the current radar mode.
   virtual DtString submode() const;
 
   //! \brief Checks if a radar submode is specified
   //! \return True if submode is specified, false otherwise
   virtual bool submodeSpecified() const;
 
   //! \brief Sets the radar submode
   //! \param value The submode string to set
   virtual void setSubmode(const DtString& value);
 
   //! \brief Gets the antenna center azimuth
   //! \return The center azimuth angle in degrees
   //!
   //! Returns the center azimuth angle for the radar's scan pattern.
   virtual double antennaCenterAzimuth() const;
 
   //! \brief Checks if an antenna center azimuth is specified
   //! \return True if center azimuth is specified, false otherwise
   virtual bool antennaCenterAzimuthSpecified() const;
 
   //! \brief Sets the antenna center azimuth
   //! \param value The center azimuth angle in degrees
   virtual void setAntennaCenterAzimuth(double value);
 
   //! \brief Gets the antenna center elevation
   //! \return The center elevation angle in degrees
   //!
   //! Returns the center elevation angle for the radar's scan pattern.
   virtual double antennaCenterElevation() const;
 
   //! \brief Checks if an antenna center elevation is specified
   //! \return True if center elevation is specified, false otherwise
   virtual bool antennaCenterElevationSpecified() const;
 
   //! \brief Sets the antenna center elevation
   //! \param value The center elevation angle in degrees
   virtual void setAntennaCenterElevation(double value);
 
   //! \brief Gets the antenna gate size
   //! \return The gate size in degrees
   //!
   //! Returns the angular size of the radar's detection gate.
   virtual double antennaGateSize() const;
 
   //! \brief Checks if an antenna gate size is specified
   //! \return True if gate size is specified, false otherwise
   virtual bool antennaGateSizeSpecified() const;
 
   //! \brief Sets the antenna gate size
   //! \param value The gate size in degrees
   virtual void setAntennaGateSize(double value);
 
   //! \brief Gets the number of scan bars
   //! \return The number of scan bars
   //!
   //! Returns the number of horizontal scan bars in the radar's scan pattern.
   virtual int barCount() const;
 
   //! \brief Checks if a bar count is specified
   //! \return True if bar count is specified, false otherwise
   virtual bool barCountSpecified() const;
 
   //! \brief Sets the number of scan bars
   //! \param value The number of scan bars
   virtual void setBarCount(int value);
 
   //! \brief Gets the list of designated target track IDs
   //! \return Vector of track IDs for designated targets
   //!
   //! Returns the track IDs of targets that should be designated by the radar.
   virtual std::vector<int> designatedTargetTrackIds() const;
 
   //! \brief Checks if designated target track IDs are specified
   //! \return True if target track IDs are specified, false otherwise
   virtual bool designatedTargetTrackIdsSpecified() const;
 
   //! \brief Sets the list of designated target track IDs
   //! \param value Vector of track IDs to designate
   virtual void setDesignatedTargetTrackIds(const std::vector<int>& value);
 
   //! \brief Gets the network representation size
   //! \return Size in bytes of the network representation
   //!
   //! Returns the size of the full network representation padded to an 8-byte boundary.
   virtual int netRepSize() const override;
 
   //! \brief Deserializes the request from a network buffer
   //! \param contentBuffer Pointer to the network buffer
   //! \param contentSize Size of the buffer in bytes
   //! \return True if deserialization was successful
   //!
   //! Fills in the request from the provided network buffer.
   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
 
   //! \brief Serializes the request for network transmission
   //! \return True if serialization was successful
   //!
   //! Fills in the network buffer (created by base class setDataRequest) with
   //! the set data request contents.
   virtual bool setToNet() override;
 
   //! \brief Static creator function for factory registration
   //! \return Pointer to a new instance of DtSetRadarSettingsRequest
   //!
   //! This static function is used for registration with the message factory.
   static DtSetDataRequest* creator();
 
protected:
   //! \brief Operational mode of the radar (e.g., "Search", "Track")
   DtRwString myMode;
 
   //! \brief Operational submode within the current mode
   DtRwString mySubmode;
 
   //! \brief Center azimuth angle of the radar scan pattern (degrees)
   DtRwReal myAntennaCenterAzimth;
 
   //! \brief Center elevation angle of the radar scan pattern (degrees)
   DtRwReal myAntennaCenterElevation;
 
   //! \brief Angular size of the radar detection gate (degrees)
   DtRwReal myAntennaGateSize;
 
   //! \brief Number of horizontal scan bars in the radar scan pattern
   DtRwInt myBarCount;
 
   //! \brief List of track IDs for targets to designate
   DtRwIntegerList myDesignatedTargetTrackIds;
};