VR-Engage  2.2
Loading...
Searching...
No Matches
smsLoadComplete.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 when a component is done responding to a Simulation Model Set change.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19
20
21namespace makVre
22{
23
24
25constexpr const char* SmsLoadCompleteMessageType = "PlayerStation.smsLoadComplete";
26
28{
29public:
31
32
33 // Struct for defining data
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 ~SmsLoadCompleteMessage() override;
60
62 virtual void setComponentFinished(SmsComp val);
63
64 virtual bool getChanged() const;
65 virtual void setChanged(bool 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 SmsLoadCompleteMessage& 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
virtual ~SmsLoadCompleteMessage() override
SmsLoadCompleteData getData()
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
virtual void setChanged(bool val)
static makVre::DtVreMessageId theMessageId
Definition smsLoadComplete.h:85
static UInt64 theVersionNumber()
virtual SmsComp getComponentFinished() const
static SmsLoadCompleteMessage * create()
SmsComp
Definition smsLoadComplete.h:30
@ SmsComp_CommunicationManager
Definition smsLoadComplete.h:30
@ SmsComp_All
Definition smsLoadComplete.h:30
@ SmsComp_ReflectedEntityList
Definition smsLoadComplete.h:30
@ SmsComp_VisualsManager
Definition smsLoadComplete.h:30
@ SmsComp_PlayerCreationPalette
Definition smsLoadComplete.h:30
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual const std::string & type() const override
Get the name of the message type.
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual bool getChanged() const
virtual void setComponentFinished(SmsComp val)
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
bool operator==(const SmsLoadCompleteMessage &rhs) const
static SmsLoadCompleteMessage * createFromData(const SmsLoadCompleteData)
static const makVre::DtVreMessageId & theId()
SmsLoadCompleteData getData() const
static const std::string & theType()
static message identity functions
static SmsLoadCompleteMessage * createFrom(SmsLoadCompleteMessage *)
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
SmsLoadCompleteData myData
Definition smsLoadComplete.h:89
static UInt64 theVersion
Definition smsLoadComplete.h:86
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 * SmsLoadCompleteMessageType
Definition smsLoadComplete.h:25
SmsComp myComponentFinished
Definition smsLoadComplete.h:38
bool myChanged
Definition smsLoadComplete.h:39
bool operator==(const SmsLoadCompleteData &rhs) const
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.