vrfSessionStatus.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/vrfSessionStatus.lua
*/
/*-----------------COMMENT----------------------
Contains the state of the current VRF session, if there is one.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* VrfSessionStatusMessageType = "vrf.session.status";
 
class VREMESSAGES_DLL VrfSessionStatusMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL VrfSessionStatusData 
   {
      VrfSessionStatusData();
 
      std::string myScenarioName;
      std::string myScenarioFilename;
      std::string myTerrainFilename;
      std::string myGuiTerrainFilename;
      bool myIsHosted;
      bool myWeAreHost;
      bool myVreHost;
      bool myVrfHost;
      double myExerciseStartTime;
 
      bool operator==(const VrfSessionStatusData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static VrfSessionStatusMessage* create();
   static VrfSessionStatusMessage* createFrom(VrfSessionStatusMessage*);
   static VrfSessionStatusMessage* createFromData(const VrfSessionStatusData);
   
   //! \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 ~VrfSessionStatusMessage() override;
 
   virtual const std::string& getScenarioName() const;
   virtual void setScenarioName(const std::string& val);
 
   virtual const std::string& getScenarioFilename() const;
   virtual void setScenarioFilename(const std::string& val);
 
   virtual const std::string& getTerrainFilename() const;
   virtual void setTerrainFilename(const std::string& val);
 
   virtual const std::string& getGuiTerrainFilename() const;
   virtual void setGuiTerrainFilename(const std::string& val);
 
   virtual bool getIsHosted() const;
   virtual void setIsHosted(bool val);
 
   virtual bool getWeAreHost() const;
   virtual void setWeAreHost(bool val);
 
   virtual bool getVreHost() const;
   virtual void setVreHost(bool val);
 
   virtual bool getVrfHost() const;
   virtual void setVrfHost(bool val);
 
   virtual double getExerciseStartTime() const;
   virtual void setExerciseStartTime(double val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   VrfSessionStatusData getData();
   VrfSessionStatusData getData() const;
 
   // Operators
   bool operator==(const VrfSessionStatusMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   VrfSessionStatusMessage();
 
   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
   VrfSessionStatusData myData;
};
 
} // ::makVre