VR-Engage  2.2
Loading...
Searching...
No Matches
forwardMessage.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/utilities/vreMessageManager/networkForwarderMessages.lua
10*/
11/*-----------------COMMENT----------------------
12Send to start forwarding the specified event manager message type to the network.
13-------------------COMMENT----------------------*/
14#pragma once
15
19#include <string>
20
21
22namespace makVre
23{
24
25
26constexpr const char* ForwardMessageMessageType = "system.network.forward.start";
27
28class VREMESSAGEMANAGER_DLL ForwardMessageMessage : public makVre::DtVreMessage
29{
30public:
31
32
33 // Struct for defining data
34 struct VREMESSAGEMANAGER_DLL ForwardMessageData
35 {
37
38 std::string myMessageName;
39
40 bool operator==(const ForwardMessageData& rhs) const;
41 };
42
43 // Default static creators to promote the usage of not using new.
47
48 //! \brief static message identity functions
49 static const std::string& theType();
52
53 //! \brief Get the name of the message type
54 virtual const std::string& type() const override;
55 virtual const makVre::DtVreMessageId& messageId() const override;
56
57 // default destructor
58 virtual ~ForwardMessageMessage() override;
59
60 virtual const std::string& getMessageName() const;
61 virtual void setMessageName(const std::string& val);
62
63
64 // Accessors
65 virtual int messageSize() const override;
66 static makVre::DtVreMessage* decode(char* buffer, int length);
69
70 // Operators
71 bool operator==(const ForwardMessageMessage& rhs) const;
72
73protected:
74 // Inaccessible default constructor to promote the usage of the static creator functions
76
77 virtual void serialize(DtStreamWriter& writer) const override;
78 virtual void deserialize(DtStreamReader& reader) override;
79
80protected:
83
84 // Store the data for future use
86};
87
88} // ::makVre
89
90
91
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
ForwardMessageData myData
Definition forwardMessage.h:85
static const std::string & theType()
static message identity functions
static UInt64 theVersionNumber()
bool operator==(const ForwardMessageMessage &rhs) const
ForwardMessageData getData()
static ForwardMessageMessage * createFrom(ForwardMessageMessage *)
virtual const std::string & getMessageName() const
static const makVre::DtVreMessageId & theId()
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
ForwardMessageData getData() const
static UInt64 theVersion
Definition forwardMessage.h:82
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void setMessageName(const std::string &val)
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static ForwardMessageMessage * createFromData(const ForwardMessageData)
virtual const std::string & type() const override
Get the name of the message type.
static ForwardMessageMessage * create()
virtual ~ForwardMessageMessage() override
static makVre::DtVreMessageId theMessageId
Definition forwardMessage.h:81
virtual int messageSize() const override
Static decode function pattern for derived classes.
Defines export macros for the VREngage Message Manager library.
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 * ForwardMessageMessageType
Definition forwardMessage.h:26
bool operator==(const ForwardMessageData &rhs) const
std::string myMessageName
Definition forwardMessage.h:38
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.