helics  3.0.1
Namespaces | Macros | Enumerations | Functions | Variables
CoreTypes.hpp File Reference
#include "../helics_enums.h"
#include <string>

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::FederateStates {
  HELICS_CREATED, helics::HELICS_INITIALIZING, helics::HELICS_EXECUTING, helics::HELICS_TERMINATING,
  helics::HELICS_ERROR, helics::HELICS_FINISHED, helics::HELICS_UNKNOWN, HELICS_UNKNOWN = HELICS_DATA_TYPE_UNKNOWN
}
 
enum  helics::CoreType : int {
  helics::CoreType::DEFAULT = HELICS_CORE_TYPE_DEFAULT, helics::CoreType::ZMQ = HELICS_CORE_TYPE_ZMQ, helics::CoreType::MPI = HELICS_CORE_TYPE_MPI, helics::CoreType::TEST = HELICS_CORE_TYPE_TEST,
  helics::CoreType::INTERPROCESS = HELICS_CORE_TYPE_INTERPROCESS, helics::CoreType::IPC = HELICS_CORE_TYPE_IPC, helics::CoreType::TCP = HELICS_CORE_TYPE_TCP, helics::CoreType::TCP_SS = HELICS_CORE_TYPE_TCP_SS,
  helics::CoreType::UDP = HELICS_CORE_TYPE_UDP, helics::CoreType::NNG = HELICS_CORE_TYPE_NNG, helics::CoreType::ZMQ_SS = HELICS_CORE_TYPE_ZMQ_SS, helics::CoreType::HTTP = HELICS_CORE_TYPE_HTTP,
  helics::CoreType::WEBSOCKET = HELICS_CORE_TYPE_WEBSOCKET, helics::CoreType::INPROC = HELICS_CORE_TYPE_INPROC, helics::CoreType::NULLCORE = HELICS_CORE_TYPE_NULL, helics::CoreType::EMPTY = HELICS_CORE_TYPE_EMPTY,
  helics::CoreType::UNRECOGNIZED = 22, helics::CoreType::MULTI = 45
}
 
enum  helics::MessageProcessingResult : signed char {
  helics::MessageProcessingResult::CONTINUE_PROCESSING = -2, helics::MessageProcessingResult::DELAY_MESSAGE = -1, helics::MessageProcessingResult::NEXT_STEP = 0, helics::MessageProcessingResult::ITERATING = 2,
  helics::MessageProcessingResult::HALTED = 3, helics::MessageProcessingResult::ERROR_RESULT = 7, REPROCESS_MESSAGE = 8
}
 
enum  helics::IterationResult : signed char { helics::IterationResult::NEXT_STEP = 0, helics::IterationResult::ITERATING = 2, helics::IterationResult::HALTED = 3, helics::IterationResult::ERROR_RESULT = 7 }
 
enum  helics::IterationRequest : signed char { helics::IterationRequest::NO_ITERATIONS = 0, helics::IterationRequest::FORCE_ITERATION = 1, helics::IterationRequest::ITERATE_IF_NEEDED = 2 }
 
enum  helics::InterfaceType : char {
  UNKNOWN = 'u', helics::InterfaceType::PUBLICATION = 'p', helics::InterfaceType::INPUT = 'i', helics::InterfaceType::ENDPOINT = 'e',
  helics::InterfaceType::FILTER = 'f'
}
 

Functions

const std::string & helics::fedStateString (FederateStates state)
 
bool helics::returnableResult (MessageProcessingResult 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
 

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

Referenced by helics::FederateState::enterExecutingMode().

◆ ITERATE_IF_NEEDED

constexpr auto ITERATE_IF_NEEDED
constexpr
Initial value:

simplified alias to indicate that helics should iterate if warranted

Referenced by helics::FederateState::enterExecutingMode().

◆ 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::IterationRequest::FORCE_ITERATION
@ FORCE_ITERATION
force an iteration whether it is needed or not
helics::IterationRequest::ITERATE_IF_NEEDED
@ ITERATE_IF_NEEDED
indicator that the iterations need to continue
helics::IterationRequest::NO_ITERATIONS
@ NO_ITERATIONS
indicator that the iterations have completed