vrfResourceUpdate.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/vrfResources.lua
*/
/*-----------------COMMENT----------------------
DtVrfRemoteControlConnector converts incoming makVrfEvents::DtResourceResponseEvent messages into individual VrfResourceUpdateMessage events.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* VrfResourceUpdateMessageType = "vrf.resource.update";
 
class VREMESSAGES_DLL VrfResourceUpdateMessage : public makVre::DtVreMessage
{
public:
 
   struct VREMESSAGES_DLL Resource
   {
      Resource();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const Resource& rhs) const;
      
      DtEntityType myResourceType;
      std::string myResourceName;
      double myCurrentAmount;
      double myFullAmount;
 
   };
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL VrfResourceUpdateData 
   {
      VrfResourceUpdateData();
 
      DtEntityIdentifier myEntityId;
      std::vector<Resource> myResources;
 
      bool operator==(const VrfResourceUpdateData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static VrfResourceUpdateMessage* create();
   static VrfResourceUpdateMessage* createFrom(VrfResourceUpdateMessage*);
   static VrfResourceUpdateMessage* createFromData(const VrfResourceUpdateData);
   
   //! \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 ~VrfResourceUpdateMessage() override;
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
   virtual const std::vector<Resource>& getResources() const;
   virtual void setResources(const std::vector<Resource>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   VrfResourceUpdateData getData();
   VrfResourceUpdateData getData() const;
 
   // Operators
   bool operator==(const VrfResourceUpdateMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   VrfResourceUpdateMessage();
 
   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
   VrfResourceUpdateData myData;
};
 
} // ::makVre