ExtendedStateRequest.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/entity.lua
*/
/*-----------------COMMENT----------------------
Sent to request a single extended state value from an entity. Response will be an entity.state.<type> message. See EntityStateBoolMessage, for example.
-------------------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* ExtendedStateRequestMessageType = "entity.extendedState.request";
 
class VREMESSAGES_DLL ExtendedStateRequestMessage : public makVre::DtVreMessage
{
public:
   enum transport {transport_EXT_DATA, transport_STATE_PROP};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL ExtendedStateRequestData 
   {
      ExtendedStateRequestData();
 
      DtEntityIdentifier myId;
      std::string myAttributeName;
      std::string myType;
      transport myTransport;
      bool myWarnIfMissing;
 
      bool operator==(const ExtendedStateRequestData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static ExtendedStateRequestMessage* create();
   static ExtendedStateRequestMessage* createFrom(ExtendedStateRequestMessage*);
   static ExtendedStateRequestMessage* createFromData(const ExtendedStateRequestData);
   
   //! \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 ~ExtendedStateRequestMessage() override;
 
   virtual const DtEntityIdentifier& getId() const;
   virtual void setId(const DtEntityIdentifier& val);
 
   virtual const std::string& getAttributeName() const;
   virtual void setAttributeName(const std::string& val);
 
   virtual const std::string& getType() const;
   virtual void setType(const std::string& val);
 
   virtual transport getTransport() const;
   virtual void setTransport(transport val);
 
   virtual bool getWarnIfMissing() const;
   virtual void setWarnIfMissing(bool val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   ExtendedStateRequestData getData();
   ExtendedStateRequestData getData() const;
 
   // Operators
   bool operator==(const ExtendedStateRequestMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   ExtendedStateRequestMessage();
 
   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
   ExtendedStateRequestData myData;
};
 
} // ::makVre