radarStateData.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/radarScope.lua
*/
/*-----------------COMMENT----------------------
This message is used to transmit radar state data to the HUD and radar instrument. Sent only when a GUI is subscribing. See RadarStateSubscribeMessage.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* RadarStateDataMessageType = "radarState.data";
 
class VREMESSAGES_DLL RadarStateDataMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL RadarStateDataData 
   {
      RadarStateDataData();
 
      DtEntityIdentifier myHostId;
      std::string myRadarName;
      std::string myMode;
      std::string mySubmode;
      double myCenterAzimuth;
      double myCenterElevation;
      double myMinElevation;
      double myMaxElevation;
      double myGateSize;
      double myCurrentAzimuth;
      double myCurrentElevation;
      double myCurrentAzimuthRate;
      int myBarCount;
 
      bool operator==(const RadarStateDataData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static RadarStateDataMessage* create();
   static RadarStateDataMessage* createFrom(RadarStateDataMessage*);
   static RadarStateDataMessage* createFromData(const RadarStateDataData);
   
   //! \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 ~RadarStateDataMessage() override;
 
   virtual const DtEntityIdentifier& getHostId() const;
   virtual void setHostId(const DtEntityIdentifier& val);
 
   virtual const std::string& getRadarName() const;
   virtual void setRadarName(const std::string& val);
 
   virtual const std::string& getMode() const;
   virtual void setMode(const std::string& val);
 
   virtual const std::string& getSubmode() const;
   virtual void setSubmode(const std::string& val);
 
   virtual double getCenterAzimuth() const;
   virtual void setCenterAzimuth(double val);
 
   virtual double getCenterElevation() const;
   virtual void setCenterElevation(double val);
 
   virtual double getMinElevation() const;
   virtual void setMinElevation(double val);
 
   virtual double getMaxElevation() const;
   virtual void setMaxElevation(double val);
 
   virtual double getGateSize() const;
   virtual void setGateSize(double val);
 
   virtual double getCurrentAzimuth() const;
   virtual void setCurrentAzimuth(double val);
 
   virtual double getCurrentElevation() const;
   virtual void setCurrentElevation(double val);
 
   virtual double getCurrentAzimuthRate() const;
   virtual void setCurrentAzimuthRate(double val);
 
   virtual int getBarCount() const;
   virtual void setBarCount(int val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   RadarStateDataData getData();
   RadarStateDataData getData() const;
 
   // Operators
   bool operator==(const RadarStateDataMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   RadarStateDataMessage();
 
   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
   RadarStateDataData myData;
};
 
} // ::makVre