 |
helics
3.3.0
|
9 #include "../core/CoreTypes.hpp"
10 #include "../core/helicsTime.hpp"
11 #include "helics_cxx_export.h"
33 explicit BrokerApp(std::vector<std::string> args);
44 BrokerApp(
CoreType ctype,
const std::string& broker_name, std::vector<std::string> args);
66 explicit BrokerApp(std::string_view argString);
71 explicit BrokerApp(
CoreType ctype, std::string_view argString = std::string_view{});
77 BrokerApp(
CoreType ctype, std::string_view brokerName, std::string_view argString);
80 explicit BrokerApp(std::shared_ptr<Broker> brk);
83 bool isConnected()
const;
88 bool isOpenToNewFederates()
const;
91 void forceTerminate();
93 bool waitForDisconnect(std::chrono::milliseconds waitTime = std::chrono::milliseconds(0));
95 void linkEndpoints(std::string_view source, std::string_view target);
97 void dataLink(std::string_view source, std::string_view target);
99 void addSourceFilterToEndpoint(std::string_view filter, std::string_view endpoint);
101 void addDestinationFilterToEndpoint(std::string_view filter, std::string_view endpoint);
103 void addAlias(std::string_view interfaceName, std::string_view alias);
105 void makeConnections(
const std::string& file);
107 const std::string& getIdentifier()
const;
109 const std::string& getAddress()
const;
118 std::string query(std::string_view target,
119 std::string_view queryStr,
128 void setGlobal(std::string_view valueName, std::string_view value);
138 void sendCommand(std::string_view target,
139 std::string_view commandStr,
143 void setLogFile(std::string_view logFile);
145 void setLoggingLevel(
int loglevel);
148 #ifdef HELICS_CXX_STATIC_DEFINE
151 auto* operator->()
const
153 return broker.operator->();
172 void setTimeBarrier(
Time barrierTime);
174 void clearTimeBarrier();
176 void globalError(int32_t errorCode, std::string_view errorString);
179 void processArgs(std::unique_ptr<helicsCLI11App>& app);
180 std::unique_ptr<helicsCLI11App> generateParser(
bool noTypeOption =
false);
181 std::shared_ptr<Broker> broker;
188 template<
class... Args>
189 explicit BrokerKeeper(Args&&... args): brk(std::forward<Args...>(args...))
void forceTerminate()
Force terminate the broker.
Definition: application_api/BrokerApp.hpp:199
void addSourceFilterToEndpoint(std::string_view filter, std::string_view endpoint)
Definition: BrokerApp.cpp:187
@ MULTI
use the multi-broker
CoreType coreTypeFromString(std::string_view type) noexcept
Definition: typeOperations.cpp:17
std::shared_ptr< Broker > getCopyofBrokerPointer() const
Definition: application_api/BrokerApp.hpp:166
bool isConnected() const
Definition: BrokerApp.cpp:148
CoreType
Definition: CoreTypes.hpp:36
bool isOpenToNewFederates() const
Definition: BrokerApp.cpp:158
void linkEndpoints(std::string_view source, std::string_view target)
Definition: BrokerApp.cpp:173
std::string query(std::string_view target, std::string_view queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST)
Definition: BrokerApp.cpp:229
void clearTimeBarrier()
Definition: BrokerApp.cpp:264
void setLogFile(std::string_view logFile)
Definition: BrokerApp.cpp:279
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
Definition: application_api/BrokerApp.hpp:26
const std::string & getIdentifier() const
Definition: BrokerApp.cpp:216
void displayHelp(CoreType type)
Definition: BrokerFactory.cpp:319
@ DEFAULT
ZMQ if available or UDP.
void globalError(int32_t errorCode, std::string_view errorString)
Definition: BrokerApp.cpp:271
std::shared_ptr< Broker > create(CoreType type, std::string_view configureString)
Definition: BrokerFactory.cpp:99
void dataLink(std::string_view source, std::string_view target)
Definition: BrokerApp.cpp:180
Definition: core-exceptions.hpp:85
bool waitForDisconnect(std::chrono::milliseconds waitTime=std::chrono::milliseconds(0))
Definition: BrokerApp.cpp:101
std::shared_ptr< Broker > findBroker(std::string_view brokerName)
Definition: BrokerFactory.cpp:183
~BrokerKeeper()
the destructor waits for the broker to terminate
Definition: application_api/BrokerApp.hpp:201
void reset()
Definition: BrokerApp.cpp:286
void forceTerminate()
Definition: BrokerApp.cpp:163
HelicsSequencingModes
Definition: helics_enums.h:395
void setTimeBarrier(Time barrierTime)
Definition: BrokerApp.cpp:257
void sendCommand(std::string_view target, std::string_view commandStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST)
Definition: BrokerApp.cpp:241
void setLoggingLevel(int loglevel)
Definition: BrokerApp.cpp:250
bool connect()
Definition: BrokerApp.cpp:153
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
bool isConnected()
is the broker connected
Definition: application_api/BrokerApp.hpp:197
@ HELICS_SEQUENCING_MODE_FAST
Definition: helics_enums.h:397
void setGlobal(std::string_view valueName, std::string_view value)
Definition: BrokerApp.cpp:234
void addAlias(std::string_view interfaceName, std::string_view alias)
Definition: BrokerApp.cpp:201
const std::string & getAddress() const
Definition: BrokerApp.cpp:222
Definition: application_api/BrokerApp.hpp:186
void addDestinationFilterToEndpoint(std::string_view filter, std::string_view endpoint)
Definition: BrokerApp.cpp:194
void makeConnections(const std::string &file)
Definition: BrokerApp.cpp:208