 |
helics
3.0.1
|
Go to the documentation of this file.
9 #ifndef HELICS_CORE_TYPES_HEADER
10 # define HELICS_CORE_TYPES_HEADER
12 # include "../helics_enums.h"
@ NNG
reserved for future Nanomsg implementation
@ HELICS_CORE_TYPE_DEFAULT
Definition: helics_enums.h:24
@ HELICS_CORE_TYPE_NULL
Definition: helics_enums.h:57
constexpr auto NO_ITERATION
Definition: CoreTypes.hpp:109
@ UDP
use UDP packets to send the data
@ HALTED
indicator that the simulation has been halted
@ MULTI
use the multi-broker
@ WEBSOCKET
core/broker using web sockets
bool returnableResult(MessageProcessingResult result)
Definition: CoreTypes.hpp:75
@ HELICS_CORE_TYPE_ZMQ
Definition: helics_enums.h:26
CoreType
Definition: CoreTypes.hpp:36
@ ZMQ
use the Zero MQ networking protocol
InterfaceType
Definition: CoreTypes.hpp:96
@ INPROC
core/broker using a stripped down in process core type
@ ERROR_RESULT
indicator that an error has occurred
@ HELICS_CORE_TYPE_INTERPROCESS
Definition: helics_enums.h:33
constexpr auto FORCE_ITERATION
simplified alias to force an iteration
Definition: CoreTypes.hpp:112
@ HELICS_CORE_TYPE_NNG
Definition: helics_enums.h:44
@ HELICS_UNKNOWN
unknown state
Definition: CoreTypes.hpp:29
@ HELICS_CORE_TYPE_ZMQ_SS
Definition: helics_enums.h:42
@ FILTER
handle to a filter
@ HELICS_CORE_TYPE_HTTP
Definition: helics_enums.h:48
@ HELICS_CORE_TYPE_UDP
Definition: helics_enums.h:40
@ INPUT
handle to a input interface
@ DEFAULT
ZMQ if available or UDP.
@ FORCE_ITERATION
force an iteration whether it is needed or not
@ ITERATING
indicator that the iterations need to continue
constexpr auto ITERATE_IF_NEEDED
Definition: CoreTypes.hpp:114
@ HELICS_CORE_TYPE_WEBSOCKET
Definition: helics_enums.h:50
IterationRequest
Definition: CoreTypes.hpp:89
@ DELAY_MESSAGE
delay the current message and continue processing
@ MPI
use MPI for operation on a parallel cluster
@ HELICS_CORE_TYPE_INPROC
Definition: helics_enums.h:54
IterationResult
Definition: CoreTypes.hpp:80
@ INTERPROCESS
use when all federates are on the same machine
@ ITERATE_IF_NEEDED
indicator that the iterations need to continue
@ HELICS_EXECUTING
the federation has entered execution state and it now advancing in time
Definition: CoreTypes.hpp:25
@ HELICS_CORE_TYPE_TEST
Definition: helics_enums.h:30
@ HELICS_CORE_TYPE_TCP_SS
Definition: helics_enums.h:46
@ ERROR_RESULT
indicator that an error has occurred
constexpr auto ITERATION_COMPLETE
Definition: CoreTypes.hpp:106
@ TEST
use the Test core if all federates are in the same process
@ HELICS_TERMINATING
the federate is in the process of shutting down
Definition: CoreTypes.hpp:26
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
@ ENDPOINT
handle to an endpoint
FederateStates
Definition: CoreTypes.hpp:21
@ HELICS_CORE_TYPE_IPC
Definition: helics_enums.h:36
@ ITERATING
indicator that the iterations need to continue
@ EMPTY
core type that does nothing and can't communicate
@ HTTP
core/broker using web traffic
@ CONTINUE_PROCESSING
the current loop should continue
@ IPC
same as INTERPROCESS
@ HALTED
indicator that the simulation has been halted
@ TCP
use a generic TCP protocol message stream to send messages
@ HELICS_CORE_TYPE_TCP
Definition: helics_enums.h:38
@ HELICS_ERROR
the federation has encountered an error
Definition: CoreTypes.hpp:27
MessageProcessingResult
Definition: CoreTypes.hpp:64
@ HELICS_INITIALIZING
Definition: CoreTypes.hpp:23
@ NO_ITERATIONS
indicator that the iterations have completed
@ HELICS_FINISHED
the federation has finished its execution
Definition: CoreTypes.hpp:28
@ HELICS_CORE_TYPE_EMPTY
Definition: helics_enums.h:59
@ HELICS_CORE_TYPE_MPI
Definition: helics_enums.h:28
@ NEXT_STEP
indicator that the iterations have completed
const std::string & fedStateString(FederateStates state)
Definition: FederateState.cpp:1833
@ PUBLICATION
handle to output interface
@ NULLCORE
explicit core type that doesn't exist