debugMetaData.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/vreDebugManager/debugManager.lua
*/
/*-----------------COMMENT----------------------
Used to transfer data to and from the VR-Engage debug menu.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreDebugManager/export.h>
#include <vlpi/simulationAddress.h>
#include <string>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* DebugMetaDataMessageType = "debug.meta.data";
 
class VREDEBUGMANAGER_DLL DebugMetaDataMessage : public makVre::DtVreMessage
{
public:
   enum Action {Action_SET, Action_REQUEST, Action_RESPONSE};
 
   struct VREDEBUGMANAGER_DLL KeyValuePair
   {
      KeyValuePair();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const KeyValuePair& rhs) const;
      
      std::string myKey;
      std::string myType;
      std::string myValue;
 
   };
 
 
   // Struct for defining data
   struct VREDEBUGMANAGER_DLL DebugMetaDataData 
   {
      DebugMetaDataData();
 
      DtSimulationAddress mySimulationAddress;
      std::string myDebugType;
      Action myAction;
      std::vector<KeyValuePair> myExtraData;
 
      bool operator==(const DebugMetaDataData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static DebugMetaDataMessage* create();
   static DebugMetaDataMessage* createFrom(DebugMetaDataMessage*);
   static DebugMetaDataMessage* createFromData(const DebugMetaDataData);
   
   //! \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 ~DebugMetaDataMessage() override;
 
   virtual const DtSimulationAddress& getSimulationAddress() const;
   virtual void setSimulationAddress(const DtSimulationAddress& val);
 
   virtual const std::string& getDebugType() const;
   virtual void setDebugType(const std::string& val);
 
   virtual Action getAction() const;
   virtual void setAction(Action val);
 
   virtual const std::vector<KeyValuePair>& getExtraData() const;
   virtual void setExtraData(const std::vector<KeyValuePair>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   DebugMetaDataData getData();
   DebugMetaDataData getData() const;
 
   // Operators
   bool operator==(const DebugMetaDataMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   DebugMetaDataMessage();
 
   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
   DebugMetaDataData myData;
};
 
} // ::makVre