| helics 3.6.1

queryFunctions.hpp
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2025,
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
11 #include "helics_cxx_export.h"
12
13 #include <chrono>
14 #include <string>
15 #include <string_view>
16 #include <vector>
17
18 // forward declare Federate
19 namespace helics {
20 class Federate;
21
25 HELICS_CXX_EXPORT std::vector<std::string> vectorizeQueryResult(std::string_view queryres);
29 HELICS_CXX_EXPORT std::vector<std::string> vectorizeQueryResult(std::string_view queryres);
30
34 HELICS_CXX_EXPORT std::vector<int> vectorizeIndexQuery(std::string_view queryres);
35
39 HELICS_CXX_EXPORT std::vector<std::string> vectorizeAndSortQueryResult(std::string_view queryres);
43 HELICS_CXX_EXPORT std::vector<std::string> vectorizeAndSortQueryResult(std::string_view queryres);
44
53 HELICS_CXX_EXPORT bool
54 waitForInit(helics::Federate* fed,
55 std::string_view fedName,
56 std::chrono::milliseconds timeout = std::chrono::milliseconds(10000));
57
65 HELICS_CXX_EXPORT bool
66 waitForFed(helics::Federate* fed,
67 std::string_view fedName,
68 std::chrono::milliseconds timeout = std::chrono::milliseconds(10000));
69
75 HELICS_CXX_EXPORT std::string queryFederateSubscriptions(helics::Federate* fed,
76 std::string_view fedName);
77
78 } // namespace helics
helics::Federate
Definition: application_api/Federate.hpp:48
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::vectorizeIndexQuery
std::vector< int > vectorizeIndexQuery(std::string_view queryres)
Definition: queryFunctions.cpp:54
helics::vectorizeQueryResult
std::vector< std::string > vectorizeQueryResult(std::string_view queryres)
Definition: queryFunctions.cpp:21
helics::waitForFed
bool waitForFed(helics::Federate *fed, std::string_view fedName, std::chrono::milliseconds timeout)
Definition: queryFunctions.cpp:122
helics::queryFederateSubscriptions
std::string queryFederateSubscriptions(helics::Federate *fed, std::string_view fedName)
Definition: queryFunctions.cpp:138
helics::waitForInit
bool waitForInit(helics::Federate *fed, std::string_view fedName, std::chrono::milliseconds timeout)
Definition: queryFunctions.cpp:103
helics::vectorizeAndSortQueryResult
std::vector< std::string > vectorizeAndSortQueryResult(std::string_view queryres)
Definition: queryFunctions.cpp:96