VR-Engage  2.2
Loading...
Searching...
No Matches
subscribeToBoss.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/minion.lua
10*/
11/*-----------------COMMENT----------------------
12Send from a minion to request the boss role forwards the specified message type. Used in GLStudio cockpit elements to get JoystickMessage events forwarded, to drive instrument panels.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <string>
20
21
22namespace makVre
23{
24
25
26constexpr const char* SubscribeToBossMessageType = "minion.boss.subscribe";
27
29{
30public:
31
32
33 // Struct for defining data
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 ~SubscribeToBossMessage() 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 SubscribeToBossMessage& 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
static SubscribeToBossMessage * createFrom(SubscribeToBossMessage *)
virtual void setMessageName(const std::string &val)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
SubscribeToBossData myData
Definition subscribeToBoss.h:85
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static const std::string & theType()
static message identity functions
virtual ~SubscribeToBossMessage() override
virtual const std::string & type() const override
Get the name of the message type.
bool operator==(const SubscribeToBossMessage &rhs) const
virtual int messageSize() const override
Static decode function pattern for derived classes.
static makVre::DtVreMessageId theMessageId
Definition subscribeToBoss.h:81
virtual const std::string & getMessageName() const
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
static UInt64 theVersionNumber()
static SubscribeToBossMessage * create()
SubscribeToBossData getData() const
static SubscribeToBossMessage * createFromData(const SubscribeToBossData)
static const makVre::DtVreMessageId & theId()
static UInt64 theVersion
Definition subscribeToBoss.h:82
SubscribeToBossData getData()
static makVre::DtVreMessage * decode(char *buffer, int length)
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
constexpr const char * SubscribeToBossMessageType
Definition subscribeToBoss.h:26
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
bool operator==(const SubscribeToBossData &rhs) const
std::string myMessageName
Definition subscribeToBoss.h:38
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.