helics  3.0.1
cpp98/Broker.hpp
1 /*
2 Copyright (c) 2017-2021,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 #ifndef HELICS_CPP98_BROKER_HPP_
8 #define HELICS_CPP98_BROKER_HPP_
9 #pragma once
10 
11 #include "config.hpp"
12 #include "helics/helics.h"
13 #include "helicsExceptions.hpp"
14 
15 #include <stdexcept>
16 #include <string>
17 
18 namespace helicscpp {
19 class Broker {
20  public:
22  Broker() HELICS_NOTHROW: broker(HELICS_NULL_POINTER) {}
28  Broker(std::string type, std::string name, std::string initString)
29  {
30  broker =
31  helicsCreateBroker(type.c_str(), name.c_str(), initString.c_str(), hThrowOnError());
33  throw(std::runtime_error("broker creation failed"));
34  }
35  }
42  Broker(std::string type, std::string name, int argc, char** argv)
43  {
44  broker =
45  helicsCreateBrokerFromArgs(type.c_str(), name.c_str(), argc, argv, hThrowOnError());
46  }
50  Broker& operator=(const Broker& brk)
51  {
53  return *this;
54  }
55 #ifdef HELICS_HAS_RVALUE_REFS
56 
57  Broker(Broker&& brk) HELICS_NOTHROW
58  {
59  broker = brk.broker;
60  brk.broker = HELICS_NULL_POINTER;
61  }
63  Broker& operator=(Broker&& brk) HELICS_NOTHROW
64  {
65  broker = brk.broker;
66  brk.broker = HELICS_NULL_POINTER;
67  return *this;
68  }
69 #endif
70 
71  virtual ~Broker()
72  {
73  if (broker != HELICS_NULL_POINTER) {
75  }
76  }
78  operator HelicsBroker() { return broker; }
81  HelicsBroker baseObject() const { return broker; }
83  bool isConnected() const { return (helicsBrokerIsConnected(broker) != HELICS_FALSE); }
88  bool waitForDisconnect(int msToWait = -1)
89  {
91  }
96  const char* getIdentifier() const { return helicsBrokerGetIdentifier(broker); }
98  const char* getAddress() const { return helicsBrokerGetAddress(broker); }
99 
108  void setGlobal(const std::string& valueName, const std::string& value)
109  {
110  helicsBrokerSetGlobal(broker, valueName.c_str(), value.c_str(), hThrowOnError());
111  }
115  void dataLink(const std::string& source, const std::string& target)
116  {
117  helicsBrokerDataLink(broker, source.c_str(), target.c_str(), hThrowOnError());
118  }
123  void addSourceFilterToEndpoint(const std::string& filter, const std::string& target)
124  {
126  filter.c_str(),
127  target.c_str(),
128  hThrowOnError());
129  }
134  void addDestinationFilterToEndpoint(const std::string& filter, const std::string& target)
135  {
137  filter.c_str(),
138  target.c_str(),
139  hThrowOnError());
140  }
141 
155  std::string query(const std::string& target,
156  const std::string& queryStr,
158  {
159  // returns HelicsQuery
160  HelicsQuery q = helicsCreateQuery(target.c_str(), queryStr.c_str());
161  if (mode != HELICS_SEQUENCING_MODE_FAST) {
162  helicsQuerySetOrdering(q, mode, HELICS_IGNORE_ERROR);
163  }
164  std::string result(helicsQueryBrokerExecute(q, broker, hThrowOnError()));
165  helicsQueryFree(q);
166  return result;
167  }
168 
173  void sendCommand(const std::string& target, const std::string& command)
174  {
175  helicsBrokerSendCommand(broker, target.c_str(), command.c_str(), hThrowOnError());
176  }
177 
178  void setTimeBarrier(HelicsTime barrierTime)
179  {
180  helicsBrokerSetTimeBarrier(broker, barrierTime, HELICS_IGNORE_ERROR);
181  }
182 
183  void clearTimeBarrier() { helicsBrokerClearTimeBarrier(broker); }
184 
185  void globalError(int errorCode, const std::string& errorString)
186  {
187  helicsBrokerGlobalError(broker, errorCode, errorString.c_str(), HELICS_IGNORE_ERROR);
188  }
189 
190  protected:
192 };
193 
194 } // namespace helicscpp
195 #endif
helicscpp::Broker::waitForDisconnect
bool waitForDisconnect(int msToWait=-1)
Definition: cpp98/Broker.hpp:88
helicscpp::Broker::isConnected
bool isConnected() const
Definition: cpp98/Broker.hpp:83
HelicsTime
double HelicsTime
Definition: api-data.h:90
HELICS_FALSE
const HelicsBool HELICS_FALSE
Definition: api-data.h:105
helicscpp::Broker::operator=
Broker & operator=(const Broker &brk)
Definition: cpp98/Broker.hpp:50
HELICS_TRUE
const HelicsBool HELICS_TRUE
Definition: api-data.h:104
helicsQuerySetOrdering
void helicsQuerySetOrdering(HelicsQuery query, int32_t mode, HelicsError *err)
Definition: helicsExport.cpp:1090
helicscpp::Broker::baseObject
HelicsBroker baseObject() const
Definition: cpp98/Broker.hpp:81
helicsBrokerSetTimeBarrier
void helicsBrokerSetTimeBarrier(HelicsBroker broker, HelicsTime barrierTime, HelicsError *err)
Definition: helicsExport.cpp:547
helicsBrokerClone
HelicsBroker helicsBrokerClone(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:445
helicsBrokerIsConnected
HelicsBool helicsBrokerIsConnected(HelicsBroker broker)
Definition: helicsExport.cpp:468
helicscpp::Broker
Definition: cpp98/Broker.hpp:19
helicscpp::Broker::addDestinationFilterToEndpoint
void addDestinationFilterToEndpoint(const std::string &filter, const std::string &target)
Definition: cpp98/Broker.hpp:134
helicsQueryFree
void helicsQueryFree(HelicsQuery query)
Definition: helicsExport.cpp:1099
helicsBrokerSendCommand
void helicsBrokerSendCommand(HelicsBroker broker, const char *target, const char *command, HelicsError *err)
Definition: helicsExport.cpp:520
helicscpp::Broker::dataLink
void dataLink(const std::string &source, const std::string &target)
Definition: cpp98/Broker.hpp:115
helicsBrokerFree
void helicsBrokerFree(HelicsBroker broker)
Definition: helicsExport.cpp:863
helicsBrokerGetIdentifier
const char * helicsBrokerGetIdentifier(HelicsBroker broker)
Definition: helicsExport.cpp:712
helicsBrokerDisconnect
void helicsBrokerDisconnect(HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:819
helicsBrokerClearTimeBarrier
void helicsBrokerClearTimeBarrier(HelicsBroker broker)
Definition: helicsExport.cpp:556
HelicsBroker
void * HelicsBroker
Definition: api-data.h:55
helicscpp::Broker::Broker
Broker(std::string type, std::string name, int argc, char **argv)
Definition: cpp98/Broker.hpp:42
helicscpp::Broker::getAddress
const char * getAddress() const
Definition: cpp98/Broker.hpp:98
helicscpp::Broker::Broker
Broker(std::string type, std::string name, std::string initString)
Definition: cpp98/Broker.hpp:28
helicsCreateBrokerFromArgs
HelicsBroker helicsCreateBrokerFromArgs(const char *type, const char *name, int argc, const char *const *argv, HelicsError *err)
Definition: helicsExport.cpp:412
helicscpp::hThrowOnError
Definition: helicsExceptions.hpp:38
HelicsSequencingModes
HelicsSequencingModes
Definition: helics_enums.h:363
helicscpp::Broker::sendCommand
void sendCommand(const std::string &target, const std::string &command)
Definition: cpp98/Broker.hpp:173
helicscpp::Broker::Broker
Broker() HELICS_NOTHROW
Definition: cpp98/Broker.hpp:22
helicscpp::Broker::query
std::string query(const std::string &target, const std::string &queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST) const
Definition: cpp98/Broker.hpp:155
helicsCreateBroker
HelicsBroker helicsCreateBroker(const char *type, const char *name, const char *initString, HelicsError *err)
Definition: helicsExport.cpp:384
helicsBrokerAddDestinationFilterToEndpoint
void helicsBrokerAddDestinationFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:596
helicscpp::Broker::addSourceFilterToEndpoint
void addSourceFilterToEndpoint(const std::string &filter, const std::string &target)
Definition: cpp98/Broker.hpp:123
HELICS_SEQUENCING_MODE_FAST
@ HELICS_SEQUENCING_MODE_FAST
Definition: helics_enums.h:365
helicsQueryBrokerExecute
const char * helicsQueryBrokerExecute(HelicsQuery query, HelicsBroker broker, HelicsError *err)
Definition: helicsExport.cpp:995
helicscpp::Broker::Broker
Broker(const Broker &brk)
Definition: cpp98/Broker.hpp:48
helicscpp::Broker::getIdentifier
const char * getIdentifier() const
Definition: cpp98/Broker.hpp:96
helicsBrokerAddSourceFilterToEndpoint
void helicsBrokerAddSourceFilterToEndpoint(HelicsBroker broker, const char *filter, const char *endpoint, HelicsError *err)
Definition: helicsExport.cpp:583
helicscpp::Broker::~Broker
virtual ~Broker()
Definition: cpp98/Broker.hpp:71
helicsBrokerWaitForDisconnect
HelicsBool helicsBrokerWaitForDisconnect(HelicsBroker broker, int msToWait, HelicsError *err)
Definition: helicsExport.cpp:799
helicsCreateQuery
HelicsQuery helicsCreateQuery(const char *target, const char *query)
Definition: helicsExport.cpp:942
helicsBrokerSetGlobal
void helicsBrokerSetGlobal(HelicsBroker broker, const char *valueName, const char *value, HelicsError *err)
Definition: helicsExport.cpp:507
helicsBrokerGlobalError
void helicsBrokerGlobalError(HelicsBroker broker, int errorCode, const char *errorString, HelicsError *err)
Definition: helicsExport.cpp:565
helicscpp::Broker::setGlobal
void setGlobal(const std::string &valueName, const std::string &value)
Definition: cpp98/Broker.hpp:108
HelicsQuery
void * HelicsQuery
Definition: api-data.h:72
helicscpp::Broker::broker
HelicsBroker broker
underlying broker information
Definition: cpp98/Broker.hpp:191
helicsBrokerGetAddress
const char * helicsBrokerGetAddress(HelicsBroker broker)
Definition: helicsExport.cpp:733
helicscpp::Broker::disconnect
void disconnect()
Definition: cpp98/Broker.hpp:94
helicscpp
Definition: cpp98/Broker.hpp:18
helicsBrokerDataLink
void helicsBrokerDataLink(HelicsBroker broker, const char *source, const char *target, HelicsError *err)
Definition: helicsExport.cpp:479