 |
helics
3.3.0
|
Go to the documentation of this file.
9 #ifndef HELICS_CORE_TYPES_HEADER
10 # define HELICS_CORE_TYPES_HEADER
12 # include "../helics_enums.h"
74 REPROCESS_MESSAGE = 8,
@ NNG
reserved for future Nanomsg implementation
@ HELICS_CORE_TYPE_DEFAULT
Definition: helics_enums.h:24
@ HELICS_CORE_TYPE_NULL
Definition: helics_enums.h:58
constexpr auto NO_ITERATION
simplified alias to indicate that no iterations are needed
Definition: CoreTypes.hpp:112
@ UDP
use UDP packets to send the data
@ HALTED
indicator that the simulation has been halted
@ MULTI
use the multi-broker
@ USER_RETURN
indicator that there was a return request but no other conditions or issues
@ WEBSOCKET
core/broker using web sockets
bool returnableResult(MessageProcessingResult result)
Definition: CoreTypes.hpp:78
@ 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:99
@ INPROC
core/broker using a stripped down in process core type
@ TERMINATING
the federate is in the process of shutting down
@ 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:114
@ HELICS_CORE_TYPE_NNG
Definition: helics_enums.h:45
@ HELICS_CORE_TYPE_ZMQ_SS
Definition: helics_enums.h:43
@ FILTER
handle to a filter
@ HELICS_CORE_TYPE_HTTP
Definition: helics_enums.h:49
@ HELICS_CORE_TYPE_UDP
Definition: helics_enums.h:41
@ INPUT
handle to a input interface
@ DEFAULT
ZMQ if available or UDP.
@ FORCE_ITERATION
force an iteration whether it is needed or not
constexpr auto ITERATE_IF_NEEDED
simplified alias to indicate that helics should iterate if warranted
Definition: CoreTypes.hpp:116
@ HALTED
indicator that the simulation has been halted
@ HELICS_CORE_TYPE_WEBSOCKET
Definition: helics_enums.h:51
IterationRequest
Definition: CoreTypes.hpp:92
@ ITERATING
indicator that the iterations need to continue
@ MPI
use MPI for operation on a parallel cluster
@ HELICS_CORE_TYPE_INPROC
Definition: helics_enums.h:55
IterationResult
Definition: CoreTypes.hpp:83
@ INTERPROCESS
use when all federates are on the same machine
@ ITERATE_IF_NEEDED
indicator that the iterations need to continue
@ TRANSLATOR
handle to a translator object
@ HELICS_CORE_TYPE_TEST
Definition: helics_enums.h:30
@ HELICS_CORE_TYPE_TCP_SS
Definition: helics_enums.h:47
@ ERROR_RESULT
indicator that an error has occurred
@ CONTINUE_PROCESSING
the current loop should continue
constexpr auto ITERATION_COMPLETE
simplified alias to indicate that iterations have concluded
Definition: CoreTypes.hpp:110
MessageProcessingResult
Definition: CoreTypes.hpp:64
@ TEST
use the Test core if all federates are in the same process
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
@ HELICS_CORE_TYPE_IPC
Definition: helics_enums.h:37
@ NEXT_STEP
indicator that the iterations have completed
@ EXECUTING
the federation has entered execution state and it now advancing in time
@ ITERATING
indicator that the iterations need to continue
@ FINISHED
the federation has finished its execution
@ EMPTY
core type that does nothing and can't communicate
@ HTTP
core/broker using web traffic
@ IPC
same as INTERPROCESS
@ TCP
use a generic TCP protocol message stream to send messages
@ DELAY_MESSAGE
delay the current message and continue processing
@ HELICS_CORE_TYPE_TCP
Definition: helics_enums.h:39
@ NO_ITERATIONS
indicator that the iterations have completed
@ HELICS_CORE_TYPE_EMPTY
Definition: helics_enums.h:61
@ HELICS_CORE_TYPE_MPI
Definition: helics_enums.h:28
@ ERRORED
the federation has encountered an error
FederateStates
Definition: CoreTypes.hpp:21
const std::string & fedStateString(FederateStates state)
Definition: FederateState.cpp:2035
@ PUBLICATION
handle to output interface
@ NULLCORE
explicit core type that doesn't exist