CoreTypes.hpp

Go to the documentation of this file.

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
 
#include "../helics_enums.h"
 
#include <cstdint>
#include <string>
#include <string_view>
 
namespace helics {
enum class FederateStates : std::uint8_t {
    CREATED, 
    INITIALIZING,  
    EXECUTING,  
    TERMINATING,  
    ERRORED,  
    FINISHED,  
    UNKNOWN,  
};
 
enum class CoreThreading : std::uint8_t {
    DEFAULT = HELICS_CORE_TYPE_DEFAULT,
    MULTI = HELICS_FLAG_MULTI_THREAD_CORE,
    SINGLE = HELICS_FLAG_SINGLE_THREAD_CORE
};
 
const std::string& fedStateString(FederateStates state);
 
enum class CoreType : int {
    DEFAULT = HELICS_CORE_TYPE_DEFAULT,  
    ZMQ = HELICS_CORE_TYPE_ZMQ,  
    MPI = HELICS_CORE_TYPE_MPI,  
    TEST = HELICS_CORE_TYPE_TEST,  
    INTERPROCESS = HELICS_CORE_TYPE_INTERPROCESS,  
    IPC = HELICS_CORE_TYPE_IPC,  
    TCP = HELICS_CORE_TYPE_TCP,  
    TCP_SS = HELICS_CORE_TYPE_TCP_SS,  
    UDP = HELICS_CORE_TYPE_UDP,  
    NNG = HELICS_CORE_TYPE_NNG,  
    ZMQ_SS = HELICS_CORE_TYPE_ZMQ_SS,  
    HTTP = HELICS_CORE_TYPE_HTTP,  
    WEBSOCKET = HELICS_CORE_TYPE_WEBSOCKET,  
    INPROC = HELICS_CORE_TYPE_INPROC,  
    NULLCORE = HELICS_CORE_TYPE_NULL,  
    EMPTY = HELICS_CORE_TYPE_EMPTY,  
    UNRECOGNIZED = 22,  
    MULTI = 45,  
    EXTRACT = HELICS_CORE_TYPE_EXTRACT  
};
 
enum class MessageProcessingResult : std::int8_t {
 
    CONTINUE_PROCESSING = -2,  
    DELAY_MESSAGE = -1,  
    NEXT_STEP = 0,  
    ITERATING = 2,  
    HALTED = 3,  
    USER_RETURN = 5,
    ERROR_RESULT = 7,  
    REPROCESS_MESSAGE = 8,  // indicator that the message needs to be processed again
    BUSY = 10,  // indicator that processing could not be done since the resource was busy
};
inline bool returnableResult(MessageProcessingResult result)
{
    return (result >= MessageProcessingResult::NEXT_STEP);
}
enum class IterationResult : signed char {
    NEXT_STEP = 0,  
    ITERATING = 2,  
    HALTED = 3,  
    ERROR_RESULT = 7  
};
 
enum class IterationRequest : signed char {
    NO_ITERATIONS = 0,  
    FORCE_ITERATION = 1,  
    ITERATE_IF_NEEDED = 2,  
    HALT_OPERATIONS = 3,  
    ERROR_CONDITION = 7  
};
 
enum class InterfaceType : char {
    UNKNOWN = 'u',
    PUBLICATION = 'p',  
    INPUT = 'i',  
    ENDPOINT = 'e',  
    FILTER = 'f',  
    TRANSLATOR = 't',  
    SINK = 's'  
};
 
std::string_view interfaceTypeName(InterfaceType type) noexcept;
 
}  // namespace helics
constexpr auto ITERATION_COMPLETE = helics::IterationRequest::NO_ITERATIONS;
constexpr auto NO_ITERATION = helics::IterationRequest::NO_ITERATIONS;
constexpr auto FORCE_ITERATION = helics::IterationRequest::FORCE_ITERATION;
constexpr auto ITERATE_IF_NEEDED = helics::IterationRequest::ITERATE_IF_NEEDED;