VR-Engage  2.2
Loading...
Searching...
No Matches
ExtendedStateMonitorInit.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----------------------
12Sent from the DtExtendedStateLogic (in the main thread) to the DtExtendedStateConnector (in the network thread) to tell the connector which state properties and extended data to forward events for.
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* ExtendedStateMonitorInitMessageType = "entity.extendedState.init";
28
30{
31public:
32
33
34 // Struct for defining data
36 {
38
39 DtEntityIdentifier myId;
40 std::vector<std::string> myStateName;
41 std::vector<std::string> myStateType;
42 std::vector<std::string> myPropertyName;
43 std::vector<std::string> myPropertyType;
44
46 };
47
48 // Default static creators to promote the usage of not using new.
52
53 //! \brief static message identity functions
54 static const std::string& theType();
57
58 //! \brief Get the name of the message type
59 virtual const std::string& type() const override;
60 virtual const makVre::DtVreMessageId& messageId() const override;
61
62 // default destructor
64
65 virtual const DtEntityIdentifier& getId() const;
66 virtual void setId(const DtEntityIdentifier& val);
67
68 virtual const std::vector<std::string>& getStateName() const;
69 virtual void setStateName(const std::vector<std::string>& val);
70
71 virtual const std::vector<std::string>& getStateType() const;
72 virtual void setStateType(const std::vector<std::string>& val);
73
74 virtual const std::vector<std::string>& getPropertyName() const;
75 virtual void setPropertyName(const std::vector<std::string>& val);
76
77 virtual const std::vector<std::string>& getPropertyType() const;
78 virtual void setPropertyType(const std::vector<std::string>& val);
79
80
81 // Accessors
82 virtual int messageSize() const override;
83 static makVre::DtVreMessage* decode(char* buffer, int length);
86
87 // Operators
89
90protected:
91 // Inaccessible default constructor to promote the usage of the static creator functions
93
94 virtual void serialize(DtStreamWriter& writer) const override;
95 virtual void deserialize(DtStreamReader& reader) override;
96
97protected:
100
101 // Store the data for future use
103};
104
105} // ::makVre
106
107
108
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 > & getStateName() const
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual const std::vector< std::string > & getPropertyName() const
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
static ExtendedStateMonitorInitMessage * createFrom(ExtendedStateMonitorInitMessage *)
virtual const std::vector< std::string > & getPropertyType() const
ExtendedStateMonitorInitData getData() const
virtual const DtEntityIdentifier & getId() const
virtual ~ExtendedStateMonitorInitMessage() override
ExtendedStateMonitorInitData getData()
static const std::string & theType()
static message identity functions
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual void setStateType(const std::vector< std::string > &val)
static makVre::DtVreMessage * decode(char *buffer, int length)
static makVre::DtVreMessageId theMessageId
Definition ExtendedStateMonitorInit.h:98
static UInt64 theVersion
Definition ExtendedStateMonitorInit.h:99
virtual void setPropertyType(const std::vector< std::string > &val)
virtual const std::vector< std::string > & getStateType() const
virtual void setPropertyName(const std::vector< std::string > &val)
static ExtendedStateMonitorInitMessage * createFromData(const ExtendedStateMonitorInitData)
virtual const std::string & type() const override
Get the name of the message type.
static ExtendedStateMonitorInitMessage * create()
virtual void setStateName(const std::vector< std::string > &val)
ExtendedStateMonitorInitData myData
Definition ExtendedStateMonitorInit.h:102
bool operator==(const ExtendedStateMonitorInitMessage &rhs) const
static const makVre::DtVreMessageId & theId()
virtual void setId(const DtEntityIdentifier &val)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
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 * ExtendedStateMonitorInitMessageType
Definition ExtendedStateMonitorInit.h:27
bool operator==(const ExtendedStateMonitorInitData &rhs) const
DtEntityIdentifier myId
Definition ExtendedStateMonitorInit.h:39
std::vector< std::string > myPropertyType
Definition ExtendedStateMonitorInit.h:43
std::vector< std::string > myPropertyName
Definition ExtendedStateMonitorInit.h:42
std::vector< std::string > myStateName
Definition ExtendedStateMonitorInit.h:40
std::vector< std::string > myStateType
Definition ExtendedStateMonitorInit.h:41
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.