PublicationInfo.hpp

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
 
#include "basic_CoreTypes.hpp"
#include "helicsTime.hpp"
 
#include <cstdint>
#include <string>
#include <utility>
#include <vector>
 
namespace helics {
 
struct SubscriberInformation {
    GlobalHandle id;
    std::string key;
    SubscriberInformation() = default;
    SubscriberInformation(GlobalHandle gid, std::string_view key_): id(gid), key(key_) {}
};
 
class PublicationInfo {
  public:
    PublicationInfo(GlobalHandle pid,
                    std::string_view pkey,
                    std::string_view ptype,
                    std::string_view punits): id(pid), key(pkey), type(ptype), units(punits)
    {
    }
    const GlobalHandle id;  
    std::vector<SubscriberInformation> subscribers;
    const std::string key;  
    const std::string type;  
    const std::string units;  
    SmallBuffer data;  
    Time lastPublishTime{timeZero};  
    bool has_update{false};  
    bool only_update_on_change{false};
    bool required{false};  
    bool buffer_data{false};  
    int32_t requiredConnections{0};  
    Time minTimeGap{timeZero};  
    bool CheckSetValue(const char* dataToCheck,
                       uint64_t len,
                       Time currentTime,
                       bool forceChangeCheck);
    bool addSubscriber(GlobalHandle newSubscriber, std::string_view inputName);
 
    void removeSubscriber(GlobalHandle subscriberToRemove);
    void disconnectFederate(GlobalFederateId fedToDisconnect);
    void setProperty(int32_t option, int32_t value);
    int32_t getProperty(int32_t option) const;
    const std::string& getTargets() const;
 
  private:
    mutable std::string destTargets;
};
}  // namespace helics