sarRequest.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/
 
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!This is an auto-generated file.  Any changes will be destroyed!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/sar.lua
*/
/*-----------------COMMENT----------------------
Use to request a SAR image from the connected RadarFx server.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
#include <matrix/vlVector.h>
 
 
namespace makVre
{
 
 
constexpr const char* SarRequestMessageType = "sar.request";
 
class VREMESSAGES_DLL SarRequestMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL SarRequestData 
   {
      SarRequestData();
 
      std::string myOwnshipName;
      std::string myTargetName;
      DtVector myOwnshipLocation;
      DtVector myTargetLocation;
      DtVector myRadarOffsetLocation;
      std::string myRadarName;
      double myCrossrange;
      double myDownrange;
      bool myAgcPowerEnabled;
      float myOwnshipSpeed;
      double myPower;
      int myImageSizeX;
      int myImageSizeY;
      int myImageFormat;
      int myImageDataType;
      int myImageRotation;
      int myReturnMethod;
      std::string myImageSavePath;
      std::string myImageFilename;
 
      bool operator==(const SarRequestData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static SarRequestMessage* create();
   static SarRequestMessage* createFrom(SarRequestMessage*);
   static SarRequestMessage* createFromData(const SarRequestData);
   
   //! \brief static message identity functions
   static const std::string& theType();
   static const makVre::DtVreMessageId& theId();
   static UInt64 theVersionNumber();
 
   //! \brief Get the name of the message type
   virtual const std::string& type() const override;
   virtual const makVre::DtVreMessageId& messageId() const override;
 
   // default destructor
   virtual ~SarRequestMessage() override;
 
   virtual const std::string& getOwnshipName() const;
   virtual void setOwnshipName(const std::string& val);
 
   virtual const std::string& getTargetName() const;
   virtual void setTargetName(const std::string& val);
 
   virtual const DtVector& getOwnshipLocation() const;
   virtual void setOwnshipLocation(const DtVector& val);
 
   virtual const DtVector& getTargetLocation() const;
   virtual void setTargetLocation(const DtVector& val);
 
   virtual const DtVector& getRadarOffsetLocation() const;
   virtual void setRadarOffsetLocation(const DtVector& val);
 
   virtual const std::string& getRadarName() const;
   virtual void setRadarName(const std::string& val);
 
   virtual double getCrossrange() const;
   virtual void setCrossrange(double val);
 
   virtual double getDownrange() const;
   virtual void setDownrange(double val);
 
   virtual bool getAgcPowerEnabled() const;
   virtual void setAgcPowerEnabled(bool val);
 
   virtual float getOwnshipSpeed() const;
   virtual void setOwnshipSpeed(float val);
 
   virtual double getPower() const;
   virtual void setPower(double val);
 
   virtual int getImageSizeX() const;
   virtual void setImageSizeX(int val);
 
   virtual int getImageSizeY() const;
   virtual void setImageSizeY(int val);
 
   virtual int getImageFormat() const;
   virtual void setImageFormat(int val);
 
   virtual int getImageDataType() const;
   virtual void setImageDataType(int val);
 
   virtual int getImageRotation() const;
   virtual void setImageRotation(int val);
 
   virtual int getReturnMethod() const;
   virtual void setReturnMethod(int val);
 
   virtual const std::string& getImageSavePath() const;
   virtual void setImageSavePath(const std::string& val);
 
   virtual const std::string& getImageFilename() const;
   virtual void setImageFilename(const std::string& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   SarRequestData getData();
   SarRequestData getData() const;
 
   // Operators
   bool operator==(const SarRequestMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   SarRequestMessage();
 
   virtual void serialize(DtStreamWriter& writer) const override;
   virtual void deserialize(DtStreamReader& reader) override;
 
protected:
   static makVre::DtVreMessageId theMessageId;
   static UInt64 theVersion;
 
   // Store the data for future use
   SarRequestData myData;
};
 
} // ::makVre