requestStopForwardMessage.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/
 
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!This is an auto-generated file.  Any changes will be destroyed!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/utilities/vreMessageManager/networkForwarderMessages.lua
*/
/*-----------------COMMENT----------------------
Request another VR-Engage instance stop forwarding the specified event manager message type to the network.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessageManager/export.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* RequestStopForwardMessageMessageType = "system.network.request.stop";
 
class VREMESSAGEMANAGER_DLL RequestStopForwardMessageMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGEMANAGER_DLL RequestStopForwardMessageData 
   {
      RequestStopForwardMessageData();
 
      std::string myMessageName;
      std::string myHostName;
 
      bool operator==(const RequestStopForwardMessageData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static RequestStopForwardMessageMessage* create();
   static RequestStopForwardMessageMessage* createFrom(RequestStopForwardMessageMessage*);
   static RequestStopForwardMessageMessage* createFromData(const RequestStopForwardMessageData);
   
   //! \brief static message identity functions
   static const std::string& theType();
   static const makVre::DtVreMessageId& theId();
   static UInt64 theVersionNumber();
 
   //! \brief Get the name of the message type
   virtual const std::string& type() const override;
   virtual const makVre::DtVreMessageId& messageId() const override;
 
   // default destructor
   virtual ~RequestStopForwardMessageMessage() override;
 
   virtual const std::string& getMessageName() const;
   virtual void setMessageName(const std::string& val);
 
   virtual const std::string& getHostName() const;
   virtual void setHostName(const std::string& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   RequestStopForwardMessageData getData();
   RequestStopForwardMessageData getData() const;
 
   // Operators
   bool operator==(const RequestStopForwardMessageMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   RequestStopForwardMessageMessage();
 
   virtual void serialize(DtStreamWriter& writer) const override;
   virtual void deserialize(DtStreamReader& reader) override;
 
protected:
   static makVre::DtVreMessageId theMessageId;
   static UInt64 theVersion;
 
   // Store the data for future use
   RequestStopForwardMessageData myData;
};
 
} // ::makVre