helics  2.8.1
coreTypeOperations.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 #include "core-types.hpp"
9 
10 #include <string>
11 
16 namespace helics {
17 namespace core {
19  std::string to_string(core_type type);
20 
26  core_type coreTypeFromString(std::string type) noexcept;
27 
31  bool isCoreTypeAvailable(core_type type) noexcept;
32 
38  bool matchingTypes(const std::string& type1, const std::string& type2);
39 } // namespace core
40 } // namespace helics
core-types.hpp
helics::core_type::UDP
@ UDP
use UDP packets to send the data
helics::core_type
core_type
Definition: core-types.hpp:37
helics::isCoreTypeAvailable
bool isCoreTypeAvailable(core_type type) noexcept
Definition: typeOperations.cpp:22
helics::core_type::TCP
@ TCP
use a generic TCP protocol message stream to send messages
helics::to_string
std::string to_string(core_type type)
Definition: typeOperations.cpp:12
coreTypeOperations.hpp
helics::core_type::UNRECOGNIZED
@ UNRECOGNIZED
unknown
helics::core_type::WEBSOCKET
@ WEBSOCKET
core/broker using web sockets
helics::core_type::DEFAULT
@ DEFAULT
ZMQ if available or UDP.
helics::core_type::ZMQ
@ ZMQ
use the Zero MQ networking protocol
helics::core_type::INPROC
@ INPROC
core/broker using a stripped down in process core type
helics::core_type::ZMQ_SS
@ ZMQ_SS
helics::core_type::NNG
@ NNG
reserved for future Nanomsg implementation
helics::core_type::IPC
@ IPC
same as INTERPROCESS
helics::core_type::MULTI
@ MULTI
use the multi-broker
helics::core_type::INTERPROCESS
@ INTERPROCESS
use when all federates are on the same machine
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::core_type::TCP_SS
@ TCP_SS
helics::coreTypeFromString
core_type coreTypeFromString(std::string type) noexcept
Definition: typeOperations.cpp:17
core-exceptions.hpp
helics::core_type::HTTP
@ HTTP
core/broker using web traffic
helics::core_type::NULLCORE
@ NULLCORE
explicit core type that doesn't exist
helics::core_type::MPI
@ MPI
use MPI for operation on a parallel cluster
helics::core_type::TEST
@ TEST
use the Test core if all federates are in the same process