helics  3.0.1
application_api/CoreApp.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 #pragma once
8 
9 #include "../core/CoreTypes.hpp"
10 #include "helics_cxx_export.h"
11 
12 #include <chrono>
13 #include <memory>
14 #include <string>
15 #include <utility>
16 #include <vector>
17 
18 namespace helics {
19 class Core;
20 class helicsCLI11App;
21 
25 class HELICS_CXX_EXPORT CoreApp {
26  public:
28  CoreApp() = default;
32  explicit CoreApp(std::vector<std::string> args);
37  CoreApp(CoreType ctype, std::vector<std::string> args);
38 
44  CoreApp(CoreType ctype, const std::string& coreName, std::vector<std::string> args);
49  CoreApp(int argc, char* argv[]);
56  CoreApp(CoreType ctype, const std::string& coreName, int argc, char* argv[]);
62  CoreApp(CoreType ctype, int argc, char* argv[]);
66  explicit CoreApp(const std::string& argString);
71  CoreApp(CoreType ctype, const std::string& argString);
77  CoreApp(CoreType ctype, const std::string& coreName, const std::string& argString);
78 
80  explicit CoreApp(std::shared_ptr<Core> cr);
82  bool isConnected() const;
83 
85  bool connect();
86 
89  bool isOpenToNewFederates() const;
91  void forceTerminate();
93  bool waitForDisconnect(std::chrono::milliseconds waitTime = std::chrono::milliseconds(0));
95  void linkEndpoints(const std::string& source, const std::string& target);
97  void dataLink(const std::string& source, const std::string& target);
99  void addSourceFilterToEndpoint(const std::string& filter, const std::string& endpoint);
101  void addDestinationFilterToEndpoint(const std::string& filter, const std::string& endpoint);
103  void makeConnections(const std::string& file);
105  const std::string& getIdentifier() const;
107  const std::string& getAddress() const;
108 
117  std::string query(const std::string& target,
118  const std::string& queryStr,
120 
126  void setTag(const std::string& tag, const std::string& value);
133  const std::string& getTag(const std::string& tag) const;
134 
142  void setGlobal(const std::string& valueName, const std::string& value);
143 
152  void sendCommand(const std::string& target,
153  const std::string& commandStr,
155 
157  void setLogFile(const std::string& logFile);
159  void setLoggingLevel(int loglevel);
161  void setReadyToInit();
163  void haltInit();
164 #ifdef HELICS_CXX_STATIC_DEFINE
165 
167  auto* operator->() const { return core.operator->(); }
168 #else
169  CoreApp* operator->() { return this; }
170  const CoreApp* operator->() const { return this; }
171 #endif
172 
173  std::shared_ptr<Core> getCopyofCorePointer() const { return core; }
174 
176  void reset();
178  void globalError(int32_t errorCode, const std::string& errorString);
179 
180  private:
181  void processArgs(std::unique_ptr<helicsCLI11App>& app);
182  std::unique_ptr<helicsCLI11App> generateParser();
183 
184  std::shared_ptr<Core> core;
185  std::string name;
186 };
187 
189 class CoreKeeper {
190  public:
191  template<class... Args>
192  explicit CoreKeeper(Args&&... args): cr(std::forward<Args...>(args...))
193  {
194  }
195  CoreKeeper(CoreKeeper&& brkeep) = default;
196  CoreKeeper(const CoreKeeper& crkeep) = default;
197  CoreKeeper& operator=(CoreKeeper&& crkeep) = default;
198  CoreKeeper& operator=(const CoreKeeper& crkeep) = default;
200  bool isConnected() { return cr.isConnected(); }
205  {
206  if (cr.isConnected()) {
207  cr.waitForDisconnect();
208  }
209  }
210 
211  private:
212  CoreApp cr;
213 };
214 } // namespace helics
helics::CoreApp::forceTerminate
void forceTerminate()
Definition: CoreApp.cpp:151
helics::CoreApp::waitForDisconnect
bool waitForDisconnect(std::chrono::milliseconds waitTime=std::chrono::milliseconds(0))
Definition: CoreApp.cpp:161
helics::CoreApp::setLogFile
void setLogFile(const std::string &logFile)
Definition: CoreApp.cpp:264
helics::CoreApp::dataLink
void dataLink(const std::string &source, const std::string &target)
Definition: CoreApp.cpp:176
helics::CoreApp::setGlobal
void setGlobal(const std::string &valueName, const std::string &value)
Definition: CoreApp.cpp:240
helics::CoreApp::connect
bool connect()
Definition: CoreApp.cpp:141
helics::CoreType
CoreType
Definition: CoreTypes.hpp:36
helics::CoreApp::isOpenToNewFederates
bool isOpenToNewFederates() const
Definition: CoreApp.cpp:146
helics::CoreApp::reset
void reset()
Definition: CoreApp.cpp:284
helics::CoreApp::setLoggingLevel
void setLoggingLevel(int loglevel)
Definition: CoreApp.cpp:256
helics::CoreApp::isConnected
bool isConnected() const
Definition: CoreApp.cpp:136
helics::CoreKeeper::~CoreKeeper
~CoreKeeper()
the destructor waits for the core to terminate
Definition: application_api/CoreApp.hpp:204
helics::CoreType::DEFAULT
@ DEFAULT
ZMQ if available or UDP.
HELICS_FLAG_DELAY_INIT_ENTRY
@ HELICS_FLAG_DELAY_INIT_ENTRY
Definition: helics_enums.h:146
helics::CoreApp::getAddress
const std::string & getAddress() const
Definition: CoreApp.cpp:211
helics::CoreApp::addSourceFilterToEndpoint
void addSourceFilterToEndpoint(const std::string &filter, const std::string &endpoint)
Definition: CoreApp.cpp:183
helics::CoreKeeper::isConnected
bool isConnected()
is the core connected
Definition: application_api/CoreApp.hpp:200
helics::CoreApp
Definition: application_api/CoreApp.hpp:25
helics::CoreApp::globalError
void globalError(int32_t errorCode, const std::string &errorString)
Definition: CoreApp.cpp:290
helics::CoreApp::setReadyToInit
void setReadyToInit()
Definition: CoreApp.cpp:271
helics::CoreFactory::displayHelp
void displayHelp(CoreType type)
Definition: CoreFactory.cpp:373
helics::CoreApp::getCopyofCorePointer
std::shared_ptr< Core > getCopyofCorePointer() const
Definition: application_api/CoreApp.hpp:173
helics::CoreApp::CoreApp
CoreApp()=default
helics::CoreFactory::findCore
std::shared_ptr< Core > findCore(const std::string &name)
Definition: CoreFactory.cpp:275
helics::CoreApp::addDestinationFilterToEndpoint
void addDestinationFilterToEndpoint(const std::string &filter, const std::string &endpoint)
Definition: CoreApp.cpp:190
HelicsSequencingModes
HelicsSequencingModes
Definition: helics_enums.h:363
helics::CoreKeeper::forceTerminate
void forceTerminate()
Force terminate the core.
Definition: application_api/CoreApp.hpp:202
helics::CoreApp::haltInit
void haltInit()
Definition: CoreApp.cpp:277
helics::CoreApp::getTag
const std::string & getTag(const std::string &tag) const
Definition: CoreApp.cpp:232
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::CoreApp::getIdentifier
const std::string & getIdentifier() const
Definition: CoreApp.cpp:205
HELICS_SEQUENCING_MODE_FAST
@ HELICS_SEQUENCING_MODE_FAST
Definition: helics_enums.h:365
helics::CoreApp::setTag
void setTag(const std::string &tag, const std::string &value)
Definition: CoreApp.cpp:225
helics::CoreApp::makeConnections
void makeConnections(const std::string &file)
Definition: CoreApp.cpp:197
helics::CoreApp::linkEndpoints
void linkEndpoints(const std::string &source, const std::string &target)
Definition: CoreApp.cpp:169
helics::gLocalCoreId
constexpr LocalFederateId gLocalCoreId(-259)
helics::CoreApp::query
std::string query(const std::string &target, const std::string &queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST)
Definition: CoreApp.cpp:217
helics::CoreApp::sendCommand
void sendCommand(const std::string &target, const std::string &commandStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST)
Definition: CoreApp.cpp:247
helics::CoreKeeper
Definition: application_api/CoreApp.hpp:189
helics::generateJsonErrorResponse
std::string generateJsonErrorResponse(JsonErrorCodes code, const std::string &message)
Definition: JsonGeneration.hpp:36