vrfTakeControlOf.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/vrfTakeControlOf.lua
*/
/*-----------------COMMENT----------------------
Send to take control of an entity for specified function groups. A role should be supplied for managing CGF vs player control on the entity (if a role is supplied, VR-Engage components know to disable CGF functionality).
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <string>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* VrfTakeControlOfMessageType = "vrf.takeControlOf";
 
class VREMESSAGES_DLL VrfTakeControlOfMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL VrfTakeControlOfData 
   {
      VrfTakeControlOfData();
 
      DtEntityIdentifier myEntityId;
      unsigned long myStationId;
      std::string myStationName;
      std::vector<std::string> myFunctionGroups;
      std::vector<std::string> myRoles;
 
      bool operator==(const VrfTakeControlOfData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static VrfTakeControlOfMessage* create();
   static VrfTakeControlOfMessage* createFrom(VrfTakeControlOfMessage*);
   static VrfTakeControlOfMessage* createFromData(const VrfTakeControlOfData);
   
   //! \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 ~VrfTakeControlOfMessage() override;
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
   virtual unsigned long getStationId() const;
   virtual void setStationId(unsigned long val);
 
   virtual const std::string& getStationName() const;
   virtual void setStationName(const std::string& val);
 
   virtual const std::vector<std::string>& getFunctionGroups() const;
   virtual void setFunctionGroups(const std::vector<std::string>& val);
 
   virtual const std::vector<std::string>& getRoles() const;
   virtual void setRoles(const std::vector<std::string>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   VrfTakeControlOfData getData();
   VrfTakeControlOfData getData() const;
 
   // Operators
   bool operator==(const VrfTakeControlOfMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   VrfTakeControlOfMessage();
 
   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
   VrfTakeControlOfData myData;
};
 
} // ::makVre