VR-Engage  2.2
Loading...
Searching...
No Matches
EntityStateBool.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 when a monitored boolean entity state value is updated.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20#include <string>
21
22
23namespace makVre
24{
25
26
27constexpr const char* EntityStateBoolMessageType = "entity.state.bool";
28
30{
31public:
32
33
34 // Struct for defining data
36 {
38
39 DtEntityIdentifier myEntityId;
40 std::string myAttributeName;
41 bool myValue;
42
43 bool operator==(const EntityStateBoolData& rhs) const;
44 };
45
46 // Default static creators to promote the usage of not using new.
50
51 //! \brief static message identity functions
52 static const std::string& theType();
55
56 //! \brief Get the name of the message type
57 virtual const std::string& type() const override;
58 virtual const makVre::DtVreMessageId& messageId() const override;
59
60 // default destructor
61 virtual ~EntityStateBoolMessage() override;
62
63 virtual const DtEntityIdentifier& getEntityId() const;
64 virtual void setEntityId(const DtEntityIdentifier& val);
65
66 virtual const std::string& getAttributeName() const;
67 virtual void setAttributeName(const std::string& val);
68
69 virtual bool getValue() const;
70 virtual void setValue(bool val);
71
72
73 // Accessors
74 virtual int messageSize() const override;
75 static makVre::DtVreMessage* decode(char* buffer, int length);
78
79 // Operators
80 bool operator==(const EntityStateBoolMessage& rhs) const;
81
82protected:
83 // Inaccessible default constructor to promote the usage of the static creator functions
85
86 virtual void serialize(DtStreamWriter& writer) const override;
87 virtual void deserialize(DtStreamReader& reader) override;
88
89protected:
92
93 // Store the data for future use
95};
96
97} // ::makVre
98
99
100
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
static const makVre::DtVreMessageId & theId()
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual const std::string & getAttributeName() const
static UInt64 theVersionNumber()
virtual void setValue(bool val)
static const std::string & theType()
static message identity functions
virtual const std::string & type() const override
Get the name of the message type.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static EntityStateBoolMessage * create()
virtual bool getValue() const
bool operator==(const EntityStateBoolMessage &rhs) const
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void setEntityId(const DtEntityIdentifier &val)
EntityStateBoolData getData()
virtual ~EntityStateBoolMessage() override
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual void setAttributeName(const std::string &val)
static EntityStateBoolMessage * createFromData(const EntityStateBoolData)
EntityStateBoolData myData
Definition EntityStateBool.h:94
EntityStateBoolData getData() const
static UInt64 theVersion
Definition EntityStateBool.h:91
static EntityStateBoolMessage * createFrom(EntityStateBoolMessage *)
virtual const DtEntityIdentifier & getEntityId() const
static makVre::DtVreMessageId theMessageId
Definition EntityStateBool.h:90
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 * EntityStateBoolMessageType
Definition EntityStateBool.h:27
DtEntityIdentifier myEntityId
Definition EntityStateBool.h:39
std::string myAttributeName
Definition EntityStateBool.h:40
bool myValue
Definition EntityStateBool.h:41
bool operator==(const EntityStateBoolData &rhs) const
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.