VR-Engage  2.2
Loading...
Searching...
No Matches
vrfRemoveEvent.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/vrfTriggerEvent.lua
10*/
11/*-----------------COMMENT----------------------
12Sent when a VR-Forces scenario event is removed. Handled by the makVre::DtScenarioEventManager.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <string>
20
21
22namespace makVre
23{
24
25
26constexpr const char* VrfRemoveEventMessageType = "vrf.event.remove";
27
29{
30public:
31
32
33 // Struct for defining data
35 {
37
38 std::string myName;
39 std::string myUUID;
40
41 bool operator==(const VrfRemoveEventData& rhs) const;
42 };
43
44 // Default static creators to promote the usage of not using new.
48
49 //! \brief static message identity functions
50 static const std::string& theType();
53
54 //! \brief Get the name of the message type
55 virtual const std::string& type() const override;
56 virtual const makVre::DtVreMessageId& messageId() const override;
57
58 // default destructor
59 virtual ~VrfRemoveEventMessage() override;
60
61 virtual const std::string& getName() const;
62 virtual void setName(const std::string& val);
63
64 virtual const std::string& getUUID() const;
65 virtual void setUUID(const std::string& val);
66
67
68 // Accessors
69 virtual int messageSize() const override;
70 static makVre::DtVreMessage* decode(char* buffer, int length);
73
74 // Operators
75 bool operator==(const VrfRemoveEventMessage& rhs) const;
76
77protected:
78 // Inaccessible default constructor to promote the usage of the static creator functions
80
81 virtual void serialize(DtStreamWriter& writer) const override;
82 virtual void deserialize(DtStreamReader& reader) override;
83
84protected:
87
88 // Store the data for future use
90};
91
92} // ::makVre
93
94
95
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
static const std::string & theType()
static message identity functions
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual const std::string & type() const override
Get the name of the message type.
static const makVre::DtVreMessageId & theId()
virtual const std::string & getName() const
static VrfRemoveEventMessage * createFrom(VrfRemoveEventMessage *)
static makVre::DtVreMessage * decode(char *buffer, int length)
bool operator==(const VrfRemoveEventMessage &rhs) const
VrfRemoveEventData myData
Definition vrfRemoveEvent.h:89
VrfRemoveEventData getData() const
static UInt64 theVersionNumber()
virtual void setName(const std::string &val)
static VrfRemoveEventMessage * create()
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static UInt64 theVersion
Definition vrfRemoveEvent.h:86
virtual const std::string & getUUID() const
virtual ~VrfRemoveEventMessage() override
static VrfRemoveEventMessage * createFromData(const VrfRemoveEventData)
virtual void setUUID(const std::string &val)
static makVre::DtVreMessageId theMessageId
Definition vrfRemoveEvent.h:85
VrfRemoveEventData getData()
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 * VrfRemoveEventMessageType
Definition vrfRemoveEvent.h:26
bool operator==(const VrfRemoveEventData &rhs) const
std::string myUUID
Definition vrfRemoveEvent.h:39
std::string myName
Definition vrfRemoveEvent.h:38
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.