helics_definitions.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/helics_enums.h"
 
namespace helics {
namespace defs {
    enum Flags : int32_t {
        OBSERVER = HELICS_FLAG_OBSERVER,
        UNINTERRUPTIBLE = HELICS_FLAG_UNINTERRUPTIBLE,
        INTERRUPTIBLE = HELICS_FLAG_INTERRUPTIBLE,
        SLOW_RESPONDING = HELICS_FLAG_SLOW_RESPONDING,
        REENTRANT = HELICS_FLAG_REENTRANT,
        TERMINATE_ON_ERROR = HELICS_FLAG_TERMINATE_ON_ERROR,
        SOURCE_ONLY = HELICS_FLAG_SOURCE_ONLY,
        ONLY_TRANSMIT_ON_CHANGE = HELICS_FLAG_ONLY_TRANSMIT_ON_CHANGE,
        ONLY_UPDATE_ON_CHANGE = HELICS_FLAG_ONLY_UPDATE_ON_CHANGE,
        WAIT_FOR_CURRENT_TIME_UPDATE = HELICS_FLAG_WAIT_FOR_CURRENT_TIME_UPDATE,
        RESTRICTIVE_TIME_POLICY = HELICS_FLAG_RESTRICTIVE_TIME_POLICY,
        ROLLBACK = HELICS_FLAG_ROLLBACK,
        FORWARD_COMPUTE = HELICS_FLAG_FORWARD_COMPUTE,
        REALTIME = HELICS_FLAG_REALTIME,
        SINGLE_THREAD_FEDERATE = HELICS_FLAG_SINGLE_THREAD_FEDERATE,
        DELAY_INIT_ENTRY = HELICS_FLAG_DELAY_INIT_ENTRY,
        ENABLE_INIT_ENTRY = HELICS_FLAG_ENABLE_INIT_ENTRY,
        IGNORE_TIME_MISMATCH_WARNINGS = HELICS_FLAG_IGNORE_TIME_MISMATCH_WARNINGS,
        FORCE_LOGGING_FLUSH = HELICS_FLAG_FORCE_LOGGING_FLUSH,
        DEBUGGING = HELICS_FLAG_DEBUGGING,
        DUMPLOG = HELICS_FLAG_DUMPLOG,
        CONNECTIONS_REQUIRED = HELICS_HANDLE_OPTION_CONNECTION_REQUIRED,
        CONNECTIONS_OPTIONAL = HELICS_HANDLE_OPTION_CONNECTION_OPTIONAL,
        STRICT_INPUT_TYPE_CHECKING = HELICS_HANDLE_OPTION_STRICT_TYPE_CHECKING,
        STRICT_CONFIG_CHECKING = HELICS_FLAG_STRICT_CONFIG_CHECKING,
        IGNORE_INPUT_UNIT_MISMATCH = HELICS_HANDLE_OPTION_IGNORE_UNIT_MISMATCH,
        EVENT_TRIGGERED = HELICS_FLAG_EVENT_TRIGGERED,
        PROFILING = HELICS_FLAG_PROFILING,
        PROFILING_MARKER = HELICS_FLAG_PROFILING_MARKER,
        LOCAL_PROFILING_CAPTURE = HELICS_FLAG_LOCAL_PROFILING_CAPTURE,
        CALLBACK_FEDERATE = HELICS_FLAG_CALLBACK_FEDERATE,
        ALLOW_REMOTE_CONTROL = HELICS_FLAG_ALLOW_REMOTE_CONTROL,
        DISABLE_REMOTE_CONTROL = HELICS_FLAG_DISABLE_REMOTE_CONTROL,
        USE_JSON_SERIALIZATION = HELICS_FLAG_USE_JSON_SERIALIZATION,
        AUTOMATED_TIME_REQUEST = HELICS_FLAG_AUTOMATED_TIME_REQUEST
    };
    enum Errors : int32_t {
        OK = HELICS_OK,
        REGISTRATION_FAILURE = HELICS_ERROR_REGISTRATION_FAILURE,
        CONNECTION_FAILURE = HELICS_ERROR_CONNECTION_FAILURE,
        INVALID_OBJECT = HELICS_ERROR_INVALID_OBJECT,
        INVALID_ARGUMENT = HELICS_ERROR_INVALID_ARGUMENT,
        DISCARD = HELICS_ERROR_DISCARD,
        SYSTEM_FAILURE = HELICS_ERROR_SYSTEM_FAILURE,
        WARNING = HELICS_WARNING,
        INVALID_STATE_TRANSITION = HELICS_ERROR_INVALID_STATE_TRANSITION,
        INVALID_FUNCTION_CALL = HELICS_ERROR_INVALID_FUNCTION_CALL,
        EXECUTION_FAILURE = HELICS_ERROR_EXECUTION_FAILURE,
        OTHER = HELICS_ERROR_OTHER,
    };
 
    enum Properties : int32_t {
        TIME_DELTA = HELICS_PROPERTY_TIME_DELTA,
        PERIOD = HELICS_PROPERTY_TIME_PERIOD,
        OFFSET = HELICS_PROPERTY_TIME_OFFSET,
        RT_LAG = HELICS_PROPERTY_TIME_RT_LAG,
        RT_LEAD = HELICS_PROPERTY_TIME_RT_LEAD,
        RT_TOLERANCE = HELICS_PROPERTY_TIME_RT_TOLERANCE,
        GRANT_TIMEOUT = HELICS_PROPERTY_TIME_GRANT_TIMEOUT,
        INPUT_DELAY = HELICS_PROPERTY_TIME_INPUT_DELAY,
        OUTPUT_DELAY = HELICS_PROPERTY_TIME_OUTPUT_DELAY,
        CURRENT_ITERATION = HELICS_PROPERTY_INT_CURRENT_ITERATION,
        MAX_ITERATIONS = HELICS_PROPERTY_INT_MAX_ITERATIONS,
        LOG_LEVEL = HELICS_PROPERTY_INT_LOG_LEVEL,
        STOPTIME = HELICS_PROPERTY_TIME_STOPTIME,
        FILE_LOG_LEVEL = HELICS_PROPERTY_INT_FILE_LOG_LEVEL,
        CONSOLE_LOG_LEVEL = HELICS_PROPERTY_INT_CONSOLE_LOG_LEVEL,
        LOG_BUFFER = HELICS_PROPERTY_INT_LOG_BUFFER,
        INDEX_GROUP = HELICS_PROPERTY_INT_INDEX_GROUP,
        VALUE_BUFFER_WARNING = HELICS_PROPERTY_INT_VALUE_BUFFER_WARNING
    };
 
    enum Options : int32_t {
        CONNECTION_REQUIRED = HELICS_HANDLE_OPTION_CONNECTION_REQUIRED,
        CONNECTION_OPTIONAL = HELICS_HANDLE_OPTION_CONNECTION_OPTIONAL,
        SINGLE_CONNECTION_ONLY = HELICS_HANDLE_OPTION_SINGLE_CONNECTION_ONLY,
        MULTIPLE_CONNECTIONS_ALLOWED = HELICS_HANDLE_OPTION_MULTIPLE_CONNECTIONS_ALLOWED,
        HANDLE_ONLY_TRANSMIT_ON_CHANGE = HELICS_HANDLE_OPTION_ONLY_TRANSMIT_ON_CHANGE,
        HANDLE_ONLY_UPDATE_ON_CHANGE = HELICS_HANDLE_OPTION_ONLY_UPDATE_ON_CHANGE,
        BUFFER_DATA = HELICS_HANDLE_OPTION_BUFFER_DATA,
        RECONNECTABLE = HELICS_HANDLE_OPTION_RECONNECTABLE,
        RECEIVE_ONLY = HELICS_HANDLE_OPTION_RECEIVE_ONLY,
        SEND_ONLY = HELICS_HANDLE_OPTION_SOURCE_ONLY,
        IGNORE_INTERRUPTS = HELICS_HANDLE_OPTION_IGNORE_INTERRUPTS,
        STRICT_TYPE_CHECKING = HELICS_HANDLE_OPTION_STRICT_TYPE_CHECKING,
        IGNORE_UNIT_MISMATCH = HELICS_HANDLE_OPTION_IGNORE_UNIT_MISMATCH,
        MULTI_INPUT_HANDLING_METHOD = HELICS_HANDLE_OPTION_MULTI_INPUT_HANDLING_METHOD,
        INPUT_PRIORITY_LOCATION = HELICS_HANDLE_OPTION_INPUT_PRIORITY_LOCATION,
        CLEAR_PRIORITY_LIST = HELICS_HANDLE_OPTION_CLEAR_PRIORITY_LIST,
        CONNECTIONS = HELICS_HANDLE_OPTION_CONNECTIONS,
        TIME_RESTRICTED = HELICS_HANDLE_OPTION_TIME_RESTRICTED
    };
 
}  // namespace defs
}  // namespace helics