helics  2.8.1
Namespaces | Macros | Enumerations | Functions | Variables
core-types.hpp File Reference
#include "../helics_enums.h"
#include <string>
#include "../application_api/typeOperations.hpp"

Go to the source code of this file.

Namespaces

 helics
 the main namespace for the helics co-simulation library User functions will be in the helics namespace with internal functions possible in a lower level namespace
 

Enumerations

enum  helics::federate_state {
  HELICS_CREATED, helics::HELICS_INITIALIZING, helics::HELICS_EXECUTING, helics::HELICS_TERMINATING,
  helics::HELICS_ERROR, helics::HELICS_FINISHED, helics::HELICS_UNKNOWN
}
 
enum  helics::core_type : int {
  helics::core_type::DEFAULT = helics_core_type_default, helics::core_type::ZMQ = helics_core_type_zmq, helics::core_type::MPI = helics_core_type_mpi, helics::core_type::TEST = helics_core_type_test,
  helics::core_type::INTERPROCESS = helics_core_type_interprocess, helics::core_type::IPC = helics_core_type_ipc, helics::core_type::TCP = helics_core_type_tcp, helics::core_type::TCP_SS = helics_core_type_tcp_ss,
  helics::core_type::UDP = helics_core_type_udp, helics::core_type::NNG = helics_core_type_nng, helics::core_type::ZMQ_SS = helics_core_type_zmq_test, helics::core_type::HTTP = helics_core_type_http,
  helics::core_type::WEBSOCKET = helics_core_type_websocket, helics::core_type::INPROC = helics_core_type_inproc, helics::core_type::NULLCORE = helics_core_type_null, helics::core_type::UNRECOGNIZED = 22,
  helics::core_type::MULTI = 45
}
 
enum  helics::message_processing_result : signed char {
  helics::message_processing_result::continue_processing = -2, helics::message_processing_result::delay_message = -1, helics::message_processing_result::next_step = 0, helics::message_processing_result::error = 1,
  helics::message_processing_result::halted = 2, helics::message_processing_result::iterating = 3, reprocess_message = 8
}
 
enum  helics::iteration_result : signed char { helics::iteration_result::next_step = 0, helics::iteration_result::error = 1, helics::iteration_result::halted = 2, helics::iteration_result::iterating = 3 }
 
enum  helics::iteration_request : signed char { helics::iteration_request::no_iterations = 0, helics::iteration_request::force_iteration = 1, helics::iteration_request::iterate_if_needed = 2 }
 

Functions

const std::string & helics::fedStateString (federate_state state)
 
bool helics::returnableResult (message_processing_result result)
 

Variables

constexpr auto ITERATION_COMPLETE
 
constexpr auto NO_ITERATION
 
constexpr auto FORCE_ITERATION
 simplified alias to force an iteration More...
 
constexpr auto ITERATE_IF_NEEDED
 warranted More...
 

Detailed Description

definitions of types an enumerations used in helics

Variable Documentation

◆ FORCE_ITERATION

constexpr auto FORCE_ITERATION
constexpr
Initial value:

simplified alias to force an iteration

◆ ITERATE_IF_NEEDED

constexpr auto ITERATE_IF_NEEDED
constexpr
Initial value:

warranted

simplified alias to indicate that helics should iterate if

◆ ITERATION_COMPLETE

constexpr auto ITERATION_COMPLETE
constexpr
Initial value:

simplified alias to indicate that iterations have concluded

◆ NO_ITERATION

constexpr auto NO_ITERATION
constexpr
Initial value:

simplified alias to indicate that no iterations are needed

helics::iteration_request::force_iteration
@ force_iteration
force an iteration whether it is needed or not
helics::iteration_request::iterate_if_needed
@ iterate_if_needed
indicator that the iterations need to continue
helics::iteration_request::no_iterations
@ no_iterations
indicator that the iterations have completed