VR-Engage  2.2
Loading...
Searching...
No Matches
CmConfigResponse.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/entity.lua
10*/
11/*-----------------COMMENT----------------------
12Response to CmConfigRequestMessage.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20#include <vector>
21
22
23namespace makVre
24{
25
26
27constexpr const char* CmConfigResponseMessageType = "entity.cmConfig.response";
28
30{
31public:
32
34 {
36
37 int size() const;
38 void serialize(DtStreamWriter& writer) const;
40 bool operator==(const CmConfig& rhs) const;
41
42 std::string myName;
43 std::string myDisplayLabel;
45
46 };
47
48
49 // Struct for defining data
51 {
53
54 DtEntityIdentifier myEntityId;
55 std::vector<CmConfig> myCmConfigs;
57
58 bool operator==(const CmConfigResponseData& rhs) const;
59 };
60
61 // Default static creators to promote the usage of not using new.
65
66 //! \brief static message identity functions
67 static const std::string& theType();
70
71 //! \brief Get the name of the message type
72 virtual const std::string& type() const override;
73 virtual const makVre::DtVreMessageId& messageId() const override;
74
75 // default destructor
76 virtual ~CmConfigResponseMessage() override;
77
78 virtual const DtEntityIdentifier& getEntityId() const;
79 virtual void setEntityId(const DtEntityIdentifier& val);
80
81 virtual const std::vector<CmConfig>& getCmConfigs() const;
82 virtual void setCmConfigs(const std::vector<CmConfig>& val);
83
84 virtual bool getAutoCmEnabled() const;
85 virtual void setAutoCmEnabled(bool val);
86
87
88 // Accessors
89 virtual int messageSize() const override;
90 static makVre::DtVreMessage* decode(char* buffer, int length);
93
94 // Operators
95 bool operator==(const CmConfigResponseMessage& rhs) const;
96
97protected:
98 // Inaccessible default constructor to promote the usage of the static creator functions
100
101 virtual void serialize(DtStreamWriter& writer) const override;
102 virtual void deserialize(DtStreamReader& reader) override;
103
104protected:
107
108 // Store the data for future use
110};
111
112} // ::makVre
113
114
115
virtual const std::vector< CmConfig > & getCmConfigs() const
static CmConfigResponseMessage * createFrom(CmConfigResponseMessage *)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static const makVre::DtVreMessageId & theId()
virtual const DtEntityIdentifier & getEntityId() const
CmConfigResponseData myData
Definition CmConfigResponse.h:109
virtual const std::string & type() const override
Get the name of the message type.
virtual void setAutoCmEnabled(bool val)
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static const std::string & theType()
static message identity functions
virtual void setEntityId(const DtEntityIdentifier &val)
CmConfigResponseData getData()
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
static CmConfigResponseMessage * create()
virtual ~CmConfigResponseMessage() override
static makVre::DtVreMessage * decode(char *buffer, int length)
CmConfigResponseData getData() const
static UInt64 theVersion
Definition CmConfigResponse.h:106
virtual void setCmConfigs(const std::vector< CmConfig > &val)
static CmConfigResponseMessage * createFromData(const CmConfigResponseData)
bool operator==(const CmConfigResponseMessage &rhs) const
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual bool getAutoCmEnabled() const
static makVre::DtVreMessageId theMessageId
Definition CmConfigResponse.h:105
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
constexpr const char * CmConfigResponseMessageType
Definition CmConfigResponse.h:27
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
int myAmount
Definition CmConfigResponse.h:44
std::string myName
Definition CmConfigResponse.h:42
void serialize(DtStreamWriter &writer) const
void deserialize(DtStreamReader &reader)
bool operator==(const CmConfig &rhs) const
std::string myDisplayLabel
Definition CmConfigResponse.h:43
std::vector< CmConfig > myCmConfigs
Definition CmConfigResponse.h:55
bool operator==(const CmConfigResponseData &rhs) const
bool myAutoCmEnabled
Definition CmConfigResponse.h:56
DtEntityIdentifier myEntityId
Definition CmConfigResponse.h:54
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.