helics  2.8.1
queryFunctions.hpp
Go to the documentation of this file.
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 
11 #include "helics_cxx_export.h"
12 
13 #include <chrono>
14 #include <string>
15 #include <vector>
16 
17 // forward declare Federate
18 namespace helics {
19 class Federate;
20 
24 HELICS_CXX_EXPORT std::vector<std::string> vectorizeQueryResult(std::string&& queryres);
28 HELICS_CXX_EXPORT std::vector<std::string> vectorizeQueryResult(const std::string& queryres);
29 
33 HELICS_CXX_EXPORT std::vector<int> vectorizeIndexQuery(const std::string& queryres);
34 
38 HELICS_CXX_EXPORT std::vector<std::string> vectorizeAndSortQueryResult(std::string&& queryres);
42 HELICS_CXX_EXPORT std::vector<std::string> vectorizeAndSortQueryResult(const std::string& queryres);
43 
52 HELICS_CXX_EXPORT bool
54  const std::string& fedName,
55  std::chrono::milliseconds timeout = std::chrono::milliseconds(10000));
56 
64 HELICS_CXX_EXPORT bool
66  const std::string& fedName,
67  std::chrono::milliseconds timeout = std::chrono::milliseconds(10000));
68 
74 HELICS_CXX_EXPORT std::string queryFederateSubscriptions(helics::Federate* fed,
75  const std::string& fedName);
76 
77 } // namespace helics
queryFunctions.hpp
helics::queryFederateSubscriptions
std::string queryFederateSubscriptions(helics::Federate *fed, const std::string &fedName)
Definition: queryFunctions.cpp:129
helics_sequencing_mode_ordered
@ helics_sequencing_mode_ordered
Definition: helics_enums.h:337
fed
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
helics::waitForFed
bool waitForFed(helics::Federate *fed, const std::string &fedName, std::chrono::milliseconds timeout)
Definition: queryFunctions.cpp:111
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::Federate
Definition: application_api/Federate.hpp:44
helics::vectorizeQueryResult
std::vector< std::string > vectorizeQueryResult(std::string &&queryres)
Definition: queryFunctions.cpp:17
helics::waitForInit
bool waitForInit(helics::Federate *fed, const std::string &fedName, std::chrono::milliseconds timeout)
Definition: queryFunctions.cpp:90
helics::vectorizeIndexQuery
std::vector< int > vectorizeIndexQuery(const std::string &queryres)
Definition: queryFunctions.cpp:49
helics::vectorizeAndSortQueryResult
std::vector< std::string > vectorizeAndSortQueryResult(const std::string &queryres)
Definition: queryFunctions.cpp:76