core/Broker.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 "helicsTime.hpp"
 
#include <chrono>
#include <functional>
#include <string>
#include <vector>
 
namespace helics {
class Broker {
  public:
    Broker() = default;
    virtual ~Broker() = default;
 
    virtual bool connect() = 0;
    virtual void disconnect() = 0;
 
    virtual bool isConnected() const = 0;
    virtual void setAsRoot() = 0;
    virtual bool isRoot() const = 0;
 
    virtual bool isOpenToNewFederates() const = 0;
    virtual void configure(std::string_view configureString) = 0;
    virtual void configureFromArgs(int argc, char* argv[]) = 0;
    virtual void configureFromVector(std::vector<std::string> args) = 0;
    virtual const std::string& getIdentifier() const = 0;
    virtual const std::string& getAddress() const = 0;
    virtual void setLoggingLevel(int logLevel) = 0;
    virtual void setLoggingCallback(
        std::function<void(int, std::string_view, std::string_view)> logFunction) = 0;
 
    virtual void setLogFile(std::string_view lfile) = 0;
 
    virtual bool waitForDisconnect(
        std::chrono::milliseconds msToWait = std::chrono::milliseconds(0)) const = 0;
    virtual std::string query(std::string_view target,
                              std::string_view queryStr,
                              HelicsSequencingModes mode = HELICS_SEQUENCING_MODE_FAST) = 0;
 
    virtual void setGlobal(std::string_view valueName, std::string_view value) = 0;
 
    virtual void sendCommand(std::string_view target,
                             std::string_view commandStr,
                             HelicsSequencingModes mode = HELICS_SEQUENCING_MODE_FAST) = 0;
 
    virtual void makeConnections(const std::string& file) = 0;
    virtual void linkEndpoints(std::string_view source, std::string_view target) = 0;
    virtual void dataLink(std::string_view source, std::string_view target) = 0;
    virtual void addSourceFilterToEndpoint(std::string_view filter, std::string_view target) = 0;
    virtual void addDestinationFilterToEndpoint(std::string_view filter,
                                                std::string_view target) = 0;
    virtual void addAlias(std::string_view interfaceKey, std::string_view alias) = 0;
    virtual void setTimeBarrier(Time barrierTime) = 0;
 
    virtual void clearTimeBarrier() = 0;
 
    virtual void globalError(int32_t errorCode, std::string_view errorString) = 0;
};
}  // namespace helics