chat.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/chat.lua
*/
/*-----------------COMMENT----------------------
Chat message for interfacing between Network Thread and Main thread. 
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* ChatMessageType = "simulation.chat";
 
class VREMESSAGES_DLL ChatMessage : public makVre::DtVreMessage
{
public:
   enum MsgType {MsgType_SEND, MsgType_RECEIVE};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL ChatData 
   {
      ChatData();
 
      MsgType myMessageType;
      DtEntityIdentifier mySender;
      time_t myReceiveTime;
      std::string myUserName;
      std::string myChannel;
      std::string myMessage;
      int myForceType;
 
      bool operator==(const ChatData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static ChatMessage* create();
   static ChatMessage* createFrom(ChatMessage*);
   static ChatMessage* createFromData(const ChatData);
   
   //! \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 ~ChatMessage() override;
 
   virtual MsgType getMessageType() const;
   virtual void setMessageType(MsgType val);
 
   virtual const DtEntityIdentifier& getSender() const;
   virtual void setSender(const DtEntityIdentifier& val);
 
   virtual time_t getReceiveTime() const;
   virtual void setReceiveTime(time_t val);
 
   virtual const std::string& getUserName() const;
   virtual void setUserName(const std::string& val);
 
   virtual const std::string& getChannel() const;
   virtual void setChannel(const std::string& val);
 
   virtual const std::string& getMessage() const;
   virtual void setMessage(const std::string& val);
 
   virtual int getForceType() const;
   virtual void setForceType(int val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   ChatData getData();
   ChatData getData() const;
 
   // Operators
   bool operator==(const ChatMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   ChatMessage();
 
   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
   ChatData myData;
};
 
} // ::makVre