vrfTextMessage.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/textMessage.lua
*/
/*-----------------COMMENT----------------------
This class is used with the examplePlayerStationState example. 
 Receiver will be null if broadcast.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
#include <vlpi/entityIdentifier.h>
 
 
namespace makVre
{
 
 
constexpr const char* VrfTextMessageType = "admin.textMessage";
 
class VREMESSAGES_DLL VrfTextMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL VrfTextData 
   {
      VrfTextData();
 
      std::string myMessage;
      double myTime;
      DtEntityIdentifier mySenderEntityID;
      DtEntityIdentifier myReceiverEntityID;
 
      bool operator==(const VrfTextData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static VrfTextMessage* create();
   static VrfTextMessage* createFrom(VrfTextMessage*);
   static VrfTextMessage* createFromData(const VrfTextData);
   
   //! \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 ~VrfTextMessage() override;
 
   virtual const std::string& getMessage() const;
   virtual void setMessage(const std::string& val);
 
   virtual double getTime() const;
   virtual void setTime(double val);
 
   virtual const DtEntityIdentifier& getSenderEntityID() const;
   virtual void setSenderEntityID(const DtEntityIdentifier& val);
 
   virtual const DtEntityIdentifier& getReceiverEntityID() const;
   virtual void setReceiverEntityID(const DtEntityIdentifier& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   VrfTextData getData();
   VrfTextData getData() const;
 
   // Operators
   bool operator==(const VrfTextMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   VrfTextMessage();
 
   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
   VrfTextData myData;
};
 
} // ::makVre