VR-Engage  2.2
Loading...
Searching...
No Matches
designatedTargetsUpdate.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----------------------
12Sent from the radar when the designated targeting information is changed. Received by the HUD to display designated targets and by the DtVrfRemoteControlConnector to update the sim object.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20#include <string>
21#include <vector>
22
23
24namespace makVre
25{
26
27
28constexpr const char* DesignatedTargetsUpdateMessageType = "radarScope.designatedTargetsUpdate";
29
31{
32public:
33
34
35 // Struct for defining data
48
49 // Default static creators to promote the usage of not using new.
53
54 //! \brief static message identity functions
55 static const std::string& theType();
58
59 //! \brief Get the name of the message type
60 virtual const std::string& type() const override;
61 virtual const makVre::DtVreMessageId& messageId() const override;
62
63 // default destructor
65
66 virtual const DtEntityIdentifier& getHostId() const;
67 virtual void setHostId(const DtEntityIdentifier& val);
68
69 virtual const std::string& getRadarName() const;
70 virtual void setRadarName(const std::string& val);
71
72 virtual const std::vector<int>& getDesignatedTargets() const;
73 virtual void setDesignatedTargets(const std::vector<int>& val);
74
75 virtual const DtEntityIdentifier& getNextToShootTargetEntityId() const;
76 virtual void setNextToShootTargetEntityId(const DtEntityIdentifier& val);
77
78 virtual int getNextToShootTargetTrackId() const;
79 virtual void setNextToShootTargetTrackId(int val);
80
81
82 // Accessors
83 virtual int messageSize() const override;
84 static makVre::DtVreMessage* decode(char* buffer, int length);
87
88 // Operators
90
91protected:
92 // Inaccessible default constructor to promote the usage of the static creator functions
94
95 virtual void serialize(DtStreamWriter& writer) const override;
96 virtual void deserialize(DtStreamReader& reader) override;
97
98protected:
101
102 // Store the data for future use
104};
105
106} // ::makVre
107
108
109
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void setDesignatedTargets(const std::vector< int > &val)
virtual const DtEntityIdentifier & getNextToShootTargetEntityId() const
virtual int getNextToShootTargetTrackId() const
virtual const DtEntityIdentifier & getHostId() const
virtual void setRadarName(const std::string &val)
static const std::string & theType()
static message identity functions
virtual void setNextToShootTargetEntityId(const DtEntityIdentifier &val)
virtual ~DesignatedTargetsUpdateMessage() override
virtual void setHostId(const DtEntityIdentifier &val)
DesignatedTargetsUpdateData getData()
virtual const std::string & type() const override
Get the name of the message type.
static makVre::DtVreMessageId theMessageId
Definition designatedTargetsUpdate.h:99
bool operator==(const DesignatedTargetsUpdateMessage &rhs) const
DesignatedTargetsUpdateData getData() const
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static DesignatedTargetsUpdateMessage * createFromData(const DesignatedTargetsUpdateData)
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static UInt64 theVersion
Definition designatedTargetsUpdate.h:100
static makVre::DtVreMessage * decode(char *buffer, int length)
static const makVre::DtVreMessageId & theId()
virtual void setNextToShootTargetTrackId(int val)
DesignatedTargetsUpdateData myData
Definition designatedTargetsUpdate.h:103
virtual const std::string & getRadarName() const
virtual const std::vector< int > & getDesignatedTargets() const
static DesignatedTargetsUpdateMessage * create()
virtual int messageSize() const override
Static decode function pattern for derived classes.
static DesignatedTargetsUpdateMessage * createFrom(DesignatedTargetsUpdateMessage *)
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
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 * DesignatedTargetsUpdateMessageType
Definition designatedTargetsUpdate.h:28
DtEntityIdentifier myHostId
Definition designatedTargetsUpdate.h:40
DtEntityIdentifier myNextToShootTargetEntityId
Definition designatedTargetsUpdate.h:43
int myNextToShootTargetTrackId
Definition designatedTargetsUpdate.h:44
std::string myRadarName
Definition designatedTargetsUpdate.h:41
bool operator==(const DesignatedTargetsUpdateData &rhs) const
std::vector< int > myDesignatedTargets
Definition designatedTargetsUpdate.h:42
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.