setBackendConfig.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/framework/vreMessages/backend.lua
*/
/*-----------------COMMENT----------------------
Used by the DtNetworkConnectedState to set the backend configuration in the DtVrfLaunchConnector. Also handled by the DtVrfRemoteControlConnector to get site and app id.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vector>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* SetBackendConfigMessageType = "app.backend.config";
 
class VREMESSAGES_DLL SetBackendConfigMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL SetBackendConfigData 
   {
      SetBackendConfigData();
 
      int mySiteId;
      int myApplicationId;
      int mySessionId;
      std::vector<std::string> myPlugins;
      bool myShowConsole;
      std::string myAdditionalCommandLineArguments;
 
      bool operator==(const SetBackendConfigData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static SetBackendConfigMessage* create();
   static SetBackendConfigMessage* createFrom(SetBackendConfigMessage*);
   static SetBackendConfigMessage* createFromData(const SetBackendConfigData);
   
   //! \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 ~SetBackendConfigMessage() override;
 
   virtual int getSiteId() const;
   virtual void setSiteId(int val);
 
   virtual int getApplicationId() const;
   virtual void setApplicationId(int val);
 
   virtual int getSessionId() const;
   virtual void setSessionId(int val);
 
   virtual const std::vector<std::string>& getPlugins() const;
   virtual void setPlugins(const std::vector<std::string>& val);
 
   virtual bool getShowConsole() const;
   virtual void setShowConsole(bool val);
 
   virtual const std::string& getAdditionalCommandLineArguments() const;
   virtual void setAdditionalCommandLineArguments(const std::string& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   SetBackendConfigData getData();
   SetBackendConfigData getData() const;
 
   // Operators
   bool operator==(const SetBackendConfigMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   SetBackendConfigMessage();
 
   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
   SetBackendConfigData myData;
};
 
} // ::makVre