VR-Engage  2.2
Loading...
Searching...
No Matches
SetAntennaSweep.h
Go to the documentation of this file.
1/*********************************************************************************
2** Copyright (c) 2025 MAK Technologies, Inc.
3** All rights reserved.
4*********************************************************************************/
5
6/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7!!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!!
8!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/radarScope.lua
10*/
11/*-----------------COMMENT----------------------
12Updates the antenna's sweep center and width.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20
21
22namespace makVre
23{
24
25
26constexpr const char* SetAntennaSweepMessageType = "radarScope.setAntennaSweep";
27
29{
30public:
31
32
33 // Struct for defining data
35 {
37
38 DtEntityIdentifier myHostId;
39 double myAzCenter;
40 double myAzWidth;
41
42 bool operator==(const SetAntennaSweepData& rhs) const;
43 };
44
45 // Default static creators to promote the usage of not using new.
49
50 //! \brief static message identity functions
51 static const std::string& theType();
54
55 //! \brief Get the name of the message type
56 virtual const std::string& type() const override;
57 virtual const makVre::DtVreMessageId& messageId() const override;
58
59 // default destructor
60 virtual ~SetAntennaSweepMessage() override;
61
62 virtual const DtEntityIdentifier& getHostId() const;
63 virtual void setHostId(const DtEntityIdentifier& val);
64
65 virtual double getAzCenter() const;
66 virtual void setAzCenter(double val);
67
68 virtual double getAzWidth() const;
69 virtual void setAzWidth(double val);
70
71
72 // Accessors
73 virtual int messageSize() const override;
74 static makVre::DtVreMessage* decode(char* buffer, int length);
77
78 // Operators
79 bool operator==(const SetAntennaSweepMessage& rhs) const;
80
81protected:
82 // Inaccessible default constructor to promote the usage of the static creator functions
84
85 virtual void serialize(DtStreamWriter& writer) const override;
86 virtual void deserialize(DtStreamReader& reader) override;
87
88protected:
91
92 // Store the data for future use
94};
95
96} // ::makVre
97
98
99
Reader class for decoding values from a byte array.
Definition byteStream.h:42
Writer class for encoding values into a byte array.
Definition byteStream.h:161
Abstract base class for all VREngage messages.
Definition vreMessage.h:50
Message identifier class for the VREngage messaging system.
Definition vreMessageId.h:35
virtual const std::string & type() const override
Get the name of the message type.
static UInt64 theVersionNumber()
static UInt64 theVersion
Definition SetAntennaSweep.h:90
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static const std::string & theType()
static message identity functions
virtual void setAzWidth(double val)
SetAntennaSweepData getData() const
static const makVre::DtVreMessageId & theId()
static SetAntennaSweepMessage * create()
static makVre::DtVreMessageId theMessageId
Definition SetAntennaSweep.h:89
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual void setAzCenter(double val)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
virtual double getAzCenter() const
static SetAntennaSweepMessage * createFrom(SetAntennaSweepMessage *)
SetAntennaSweepData myData
Definition SetAntennaSweep.h:93
static SetAntennaSweepMessage * createFromData(const SetAntennaSweepData)
virtual void setHostId(const DtEntityIdentifier &val)
virtual double getAzWidth() const
SetAntennaSweepData getData()
virtual ~SetAntennaSweepMessage() override
bool operator==(const SetAntennaSweepMessage &rhs) const
virtual const DtEntityIdentifier & getHostId() const
Defines export macros for the VREngage Messages library.
#define VREMESSAGES_DLL
Export/import macro for non-Windows platforms.
Definition export.h:39
Include export definitions for this library.
Definition glsVreMessageUtil.h:49
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
constexpr const char * SetAntennaSweepMessageType
Definition SetAntennaSweep.h:26
double myAzWidth
Definition SetAntennaSweep.h:40
double myAzCenter
Definition SetAntennaSweep.h:39
DtEntityIdentifier myHostId
Definition SetAntennaSweep.h:38
bool operator==(const SetAntennaSweepData &rhs) const
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.