| helics 3.6.1

Namespaces | Enumerations | Functions | Variables
CoreTypes.hpp File Reference
`#include "../helics_enums.h"`
`#include <cstdint>`
`#include <string>`
`#include <string_view>`

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 class | helics::FederateStates : std::uint8_t { CREATED , helics::INITIALIZING , helics::EXECUTING , helics::TERMINATING , helics::ERRORED , helics::FINISHED , helics::UNKNOWN }
enum class | helics::CoreThreading : std::uint8_t { helics::DEFAULT = HELICS_CORE_TYPE_DEFAULT , helics::MULTI = HELICS_FLAG_MULTI_THREAD_CORE , helics::SINGLE = HELICS_FLAG_SINGLE_THREAD_CORE }
enum class | helics::CoreType : int { helics::DEFAULT = HELICS_CORE_TYPE_DEFAULT , helics::ZMQ = HELICS_CORE_TYPE_ZMQ , helics::MPI = HELICS_CORE_TYPE_MPI , helics::TEST = HELICS_CORE_TYPE_TEST , helics::INTERPROCESS = HELICS_CORE_TYPE_INTERPROCESS , helics::IPC = HELICS_CORE_TYPE_IPC , helics::TCP = HELICS_CORE_TYPE_TCP , helics::TCP_SS = HELICS_CORE_TYPE_TCP_SS , helics::UDP = HELICS_CORE_TYPE_UDP , helics::NNG = HELICS_CORE_TYPE_NNG , helics::ZMQ_SS = HELICS_CORE_TYPE_ZMQ_SS , helics::HTTP = HELICS_CORE_TYPE_HTTP , helics::WEBSOCKET = HELICS_CORE_TYPE_WEBSOCKET , helics::INPROC = HELICS_CORE_TYPE_INPROC , helics::NULLCORE = HELICS_CORE_TYPE_NULL , helics::EMPTY = HELICS_CORE_TYPE_EMPTY , helics::UNRECOGNIZED = 22 , helics::MULTI = 45 , helics::EXTRACT = HELICS_CORE_TYPE_EXTRACT }
enum class | helics::MessageProcessingResult : std::int8_t { helics::CONTINUE_PROCESSING = -2 , helics::DELAY_MESSAGE = -1 , helics::NEXT_STEP = 0 , helics::ITERATING = 2 , helics::HALTED = 3 , helics::USER_RETURN = 5 , helics::ERROR_RESULT = 7 , REPROCESS_MESSAGE = 8 , BUSY = 10 }
enum class | helics::IterationResult : signed char { helics::NEXT_STEP = 0 , helics::ITERATING = 2 , helics::HALTED = 3 , helics::ERROR_RESULT = 7 }
enum class | helics::IterationRequest : signed char { helics::NO_ITERATIONS = 0 , helics::FORCE_ITERATION = 1 , helics::ITERATE_IF_NEEDED = 2 , helics::HALT_OPERATIONS = 3 , helics::ERROR_CONDITION = 7 }
enum class | helics::InterfaceType : char { UNKNOWN = 'u' , helics::PUBLICATION = 'p' , helics::INPUT = 'i' , helics::ENDPOINT = 'e' , helics::FILTER = 'f' , helics::TRANSLATOR = 't' , helics::SINK = 's' }

## Functions
const std::string & | helics::fedStateString (FederateStates state)
bool | helics::returnableResult (MessageProcessingResult result)
std::string_view | helics::interfaceTypeName (InterfaceType type) noexcept

## Variables
constexpr auto | ITERATION_COMPLETE = helics::IterationRequest::NO_ITERATIONS
| simplified alias to indicate that iterations have concluded
constexpr auto | NO_ITERATION = helics::IterationRequest::NO_ITERATIONS
| simplified alias to indicate that no iterations are needed
constexpr auto | FORCE_ITERATION = helics::IterationRequest::FORCE_ITERATION
| simplified alias to force an iteration
constexpr auto | ITERATE_IF_NEEDED = helics::IterationRequest::ITERATE_IF_NEEDED
| simplified alias to indicate that helics should iterate if warranted

## Detailed Description

definitions of types an enumerations used in helics