VR-Engage  2.2
Loading...
Searching...
No Matches
installConnectors.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/playerStation.lua
10*/
11/*-----------------COMMENT----------------------
12Sent to install connectors configured in the role file, using the current connection type.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <string>
20#include <vector>
21
22
23namespace makVre
24{
25
26
27constexpr const char* InstallConnectorsMessageType = "system.connector.install";
28
30{
31public:
32
33
34 // Struct for defining data
36 {
38
39 std::string myEntityId;
40 std::vector<std::string> myConnectorNames;
41
42 bool operator==(const InstallConnectorsData& 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 ~InstallConnectorsMessage() override;
61
62 virtual const std::string& getEntityId() const;
63 virtual void setEntityId(const std::string& val);
64
65 virtual const std::vector<std::string>& getConnectorNames() const;
66 virtual void setConnectorNames(const std::vector<std::string>& val);
67
68
69 // Accessors
70 virtual int messageSize() const override;
71 static makVre::DtVreMessage* decode(char* buffer, int length);
74
75 // Operators
76 bool operator==(const InstallConnectorsMessage& rhs) const;
77
78protected:
79 // Inaccessible default constructor to promote the usage of the static creator functions
81
82 virtual void serialize(DtStreamWriter& writer) const override;
83 virtual void deserialize(DtStreamReader& reader) override;
84
85protected:
88
89 // Store the data for future use
91};
92
93} // ::makVre
94
95
96
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::vector< std::string > & getConnectorNames() const
static const makVre::DtVreMessageId & theId()
static UInt64 theVersion
Definition installConnectors.h:87
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual ~InstallConnectorsMessage() override
virtual void setEntityId(const std::string &val)
static InstallConnectorsMessage * createFromData(const InstallConnectorsData)
virtual const std::string & getEntityId() const
virtual int messageSize() const override
Static decode function pattern for derived classes.
static InstallConnectorsMessage * create()
static makVre::DtVreMessageId theMessageId
Definition installConnectors.h:86
virtual void setConnectorNames(const std::vector< std::string > &val)
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static makVre::DtVreMessage * decode(char *buffer, int length)
static InstallConnectorsMessage * createFrom(InstallConnectorsMessage *)
InstallConnectorsData getData() const
InstallConnectorsData myData
Definition installConnectors.h:90
bool operator==(const InstallConnectorsMessage &rhs) const
InstallConnectorsData getData()
virtual const std::string & type() const override
Get the name of the message type.
static const std::string & theType()
static message identity functions
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 * InstallConnectorsMessageType
Definition installConnectors.h:27
bool operator==(const InstallConnectorsData &rhs) const
std::string myEntityId
Definition installConnectors.h:39
std::vector< std::string > myConnectorNames
Definition installConnectors.h:40
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.