VR-Engage  2.2
Loading...
Searching...
No Matches
backendStatus.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/backend.lua
10*/
11/*-----------------COMMENT----------------------
12Contains status information for this VR-Engage's sim engine.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19
20
21namespace makVre
22{
23
24
25constexpr const char* BackendStatusMessageType = "app.backendStatus.report";
26
28{
29public:
30
31
32 // Struct for defining data
48
49 // Default static creators to promote the usage of not using new.
53
54 //! \brief static message identity functions
55 static const std::string& theType();
58
59 //! \brief Get the name of the message type
60 virtual const std::string& type() const override;
61 virtual const makVre::DtVreMessageId& messageId() const override;
62
63 // default destructor
64 virtual ~BackendStatusMessage() override;
65
66 virtual bool getEnabled() const;
67 virtual void setEnabled(bool val);
68
69 virtual bool getStarted() const;
70 virtual void setStarted(bool val);
71
72 virtual bool getCanHost() const;
73 virtual void setCanHost(bool val);
74
75 virtual bool getIdle() const;
76 virtual void setIdle(bool val);
77
78 virtual bool getLoaded() const;
79 virtual void setLoaded(bool val);
80
81 virtual bool getReloading() const;
82 virtual void setReloading(bool val);
83
84 virtual bool getLoading() const;
85 virtual void setLoading(bool val);
86
87 virtual bool getReady() const;
88 virtual void setReady(bool val);
89
90
91 // Accessors
92 virtual int messageSize() const override;
93 static makVre::DtVreMessage* decode(char* buffer, int length);
96
97 // Operators
98 bool operator==(const BackendStatusMessage& rhs) const;
99
100protected:
101 // Inaccessible default constructor to promote the usage of the static creator functions
103
104 virtual void serialize(DtStreamWriter& writer) const override;
105 virtual void deserialize(DtStreamReader& reader) override;
106
107protected:
110
111 // Store the data for future use
113};
114
115} // ::makVre
116
117
118
virtual bool getStarted() const
static UInt64 theVersion
Definition backendStatus.h:109
virtual bool getIdle() const
virtual void setStarted(bool val)
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
BackendStatusData getData()
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
virtual bool getEnabled() const
static makVre::DtVreMessage * decode(char *buffer, int length)
static const std::string & theType()
static message identity functions
virtual void setLoaded(bool val)
virtual ~BackendStatusMessage() override
virtual bool getCanHost() const
virtual void setIdle(bool val)
virtual bool getReady() const
bool operator==(const BackendStatusMessage &rhs) const
virtual bool getLoaded() const
virtual int messageSize() const override
Static decode function pattern for derived classes.
static UInt64 theVersionNumber()
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static const makVre::DtVreMessageId & theId()
static BackendStatusMessage * createFromData(const BackendStatusData)
virtual const std::string & type() const override
Get the name of the message type.
virtual bool getReloading() const
virtual void setReady(bool val)
BackendStatusData myData
Definition backendStatus.h:112
BackendStatusData getData() const
virtual void setCanHost(bool val)
static BackendStatusMessage * createFrom(BackendStatusMessage *)
static makVre::DtVreMessageId theMessageId
Definition backendStatus.h:108
static BackendStatusMessage * create()
virtual void setReloading(bool val)
virtual void setEnabled(bool val)
virtual void setLoading(bool val)
virtual bool getLoading() const
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
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
constexpr const char * BackendStatusMessageType
Definition backendStatus.h:25
bool myCanHost
Definition backendStatus.h:39
bool myLoaded
Definition backendStatus.h:41
bool myStarted
Definition backendStatus.h:38
bool myEnabled
Definition backendStatus.h:37
bool myReady
Definition backendStatus.h:44
bool myReloading
Definition backendStatus.h:42
bool myIdle
Definition backendStatus.h:40
bool operator==(const BackendStatusData &rhs) const
bool myLoading
Definition backendStatus.h:43
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.