BasicHandleInfo.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 "flagOperations.hpp"
 
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
namespace helics {
 
class BasicHandleInfo {
  public:
    BasicHandleInfo() noexcept: type_in(type), type_out(units) {}
    BasicHandleInfo(GlobalFederateId federate_id,
                    InterfaceHandle handle_id,
                    InterfaceType type_of_handle,
                    std::string_view key_name,
                    std::string_view type_name,
                    std::string_view unit_name):
        handle{federate_id, handle_id}, handleType(type_of_handle), key(key_name), type(type_name),
        units(unit_name), type_in(type), type_out(units)
 
    {
    }
 
    BasicHandleInfo(GlobalFederateId federate_id,
                    InterfaceHandle handle_id,
                    InterfaceType type_of_handle) noexcept:
        handle{federate_id, handle_id}, handleType(type_of_handle), type_in(type), type_out(units)
    {
    }
 
    BasicHandleInfo(GlobalHandle gHandle, InterfaceType type_of_handle) noexcept:
        handle{gHandle}, handleType(type_of_handle), type_in(type), type_out(units)
    {
    }
 
    const GlobalHandle handle{};  
    LocalFederateId local_fed_id{};  
    const InterfaceType handleType{InterfaceType::UNKNOWN};  
    bool used{false};  
    uint16_t flags{0};
 
    const std::string key;  
    const std::string type;  
    const std::string units;  
    const std::string& type_in;  
    const std::string& type_out;  
    InterfaceHandle getInterfaceHandle() const { return handle.handle; }
    GlobalFederateId getFederateId() const { return handle.fed_id; }
    void setTag(std::string_view tag, std::string_view value);
    const std::string& getTag(std::string_view tag) const;
    const std::pair<std::string, std::string>& getTagByIndex(size_t index) const
    {
        return tags[index];
    }
    auto tagCount() const { return tags.size(); }
 
  private:
    std::vector<std::pair<std::string, std::string>> tags;  
    static const std::string emptyString;
};
}  // namespace helics