FilterInfo.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 <memory>
#include <string>
#include <utility>
#include <vector>
 
namespace helics {
struct EptInformation {
    GlobalHandle id;
    std::string key;
    std::string type;
    EptInformation() = default;
    EptInformation(GlobalHandle gid, std::string_view key_, std::string_view type_):
        id(gid), key(key_), type(type_)
    {
    }
};
 
class FilterInfo {
  public:
    FilterInfo(GlobalBrokerId core_id_,
               InterfaceHandle handle_,
               std::string_view key_,
               std::string_view type_in_,
               std::string_view type_out_,
               bool destFilter_):
        core_id(core_id_), handle(handle_), key(key_), inputType(type_in_), outputType(type_out_),
        dest_filter(destFilter_)
    {
    }
    const GlobalBrokerId core_id;  
    const InterfaceHandle handle;  
 
    const std::string key;  
    const std::string inputType;  
    const std::string outputType;  
    std::vector<GlobalHandle> sourceTargets;
    std::vector<GlobalHandle> destTargets;
    const bool dest_filter = false;  
    bool cloning = false;  
    uint16_t flags = 0;  
    // there is a 4 byte gap here
    std::shared_ptr<FilterOperator> filterOp;  
  private:
    std::vector<EptInformation>
        sourceEndpoints;  
    std::vector<EptInformation>
        destEndpoints;  
    mutable std::string sourceEpts;
    mutable std::string destEpts;
 
  public:
    void addDestinationEndpoint(GlobalHandle dest,
                                std::string_view destName,
                                std::string_view destType);
    void addSourceEndpoint(GlobalHandle dest,
                           std::string_view sourceName,
                           std::string_view sourceType);
    void removeTarget(GlobalHandle targetId);
    const std::string& getSourceEndpoints() const;
    const std::string& getDestinationEndpoints() const;
};
}  // namespace helics