helics  3.5.1
helics_definitions.hpp
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2024,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 #pragma once
12 #include "helics/helics_enums.h"
13 
14 namespace helics {
18 namespace defs {
20  enum Flags : int32_t {
104  };
106  enum Errors : int32_t {
131  };
132 
134  enum Properties : int32_t {
135  TIME_DELTA = HELICS_PROPERTY_TIME_DELTA,
140  RT_TOLERANCE = HELICS_PROPERTY_TIME_RT_TOLERANCE,
141  GRANT_TIMEOUT = HELICS_PROPERTY_TIME_GRANT_TIMEOUT,
142  INPUT_DELAY = HELICS_PROPERTY_TIME_INPUT_DELAY,
143  OUTPUT_DELAY = HELICS_PROPERTY_TIME_OUTPUT_DELAY,
144  CURRENT_ITERATION = HELICS_PROPERTY_INT_CURRENT_ITERATION,
145  MAX_ITERATIONS = HELICS_PROPERTY_INT_MAX_ITERATIONS,
146  LOG_LEVEL = HELICS_PROPERTY_INT_LOG_LEVEL,
148  FILE_LOG_LEVEL = HELICS_PROPERTY_INT_FILE_LOG_LEVEL,
149  CONSOLE_LOG_LEVEL = HELICS_PROPERTY_INT_CONSOLE_LOG_LEVEL,
150  LOG_BUFFER = HELICS_PROPERTY_INT_LOG_BUFFER,
151  INDEX_GROUP = HELICS_PROPERTY_INT_INDEX_GROUP
152  };
153 
155  enum Options : int32_t {
156  CONNECTION_REQUIRED = HELICS_HANDLE_OPTION_CONNECTION_REQUIRED,
157  CONNECTION_OPTIONAL = HELICS_HANDLE_OPTION_CONNECTION_OPTIONAL,
158  SINGLE_CONNECTION_ONLY = HELICS_HANDLE_OPTION_SINGLE_CONNECTION_ONLY,
159  MULTIPLE_CONNECTIONS_ALLOWED = HELICS_HANDLE_OPTION_MULTIPLE_CONNECTIONS_ALLOWED,
160  HANDLE_ONLY_TRANSMIT_ON_CHANGE = HELICS_HANDLE_OPTION_ONLY_TRANSMIT_ON_CHANGE,
161  HANDLE_ONLY_UPDATE_ON_CHANGE = HELICS_HANDLE_OPTION_ONLY_UPDATE_ON_CHANGE,
162  BUFFER_DATA = HELICS_HANDLE_OPTION_BUFFER_DATA,
163  RECONNECTABLE = HELICS_HANDLE_OPTION_RECONNECTABLE,
164  RECEIVE_ONLY = HELICS_HANDLE_OPTION_RECEIVE_ONLY,
166  IGNORE_INTERRUPTS = HELICS_HANDLE_OPTION_IGNORE_INTERRUPTS,
167  STRICT_TYPE_CHECKING = HELICS_HANDLE_OPTION_STRICT_TYPE_CHECKING,
168  IGNORE_UNIT_MISMATCH = HELICS_HANDLE_OPTION_IGNORE_UNIT_MISMATCH,
169  MULTI_INPUT_HANDLING_METHOD = HELICS_HANDLE_OPTION_MULTI_INPUT_HANDLING_METHOD,
170  INPUT_PRIORITY_LOCATION = HELICS_HANDLE_OPTION_INPUT_PRIORITY_LOCATION,
171  CLEAR_PRIORITY_LIST = HELICS_HANDLE_OPTION_CLEAR_PRIORITY_LIST,
173  TIME_RESTRICTED = HELICS_HANDLE_OPTION_TIME_RESTRICTED
174  };
175 
176 } // namespace defs
177 } // namespace helics
Options
Definition: helics_definitions.hpp:155
Properties
Definition: helics_definitions.hpp:134
Errors
Definition: helics_definitions.hpp:106
@ INVALID_ARGUMENT
Definition: helics_definitions.hpp:116
@ REGISTRATION_FAILURE
Definition: helics_definitions.hpp:110
@ INVALID_OBJECT
Definition: helics_definitions.hpp:114
@ DISCARD
Definition: helics_definitions.hpp:118
@ EXECUTION_FAILURE
Definition: helics_definitions.hpp:128
@ INVALID_FUNCTION_CALL
Definition: helics_definitions.hpp:126
@ OK
Definition: helics_definitions.hpp:108
@ SYSTEM_FAILURE
Definition: helics_definitions.hpp:120
@ CONNECTION_FAILURE
Definition: helics_definitions.hpp:112
@ INVALID_STATE_TRANSITION
Definition: helics_definitions.hpp:124
@ OTHER
Definition: helics_definitions.hpp:130
Flags
Definition: helics_definitions.hpp:20
@ CONNECTIONS_OPTIONAL
Definition: helics_definitions.hpp:77
@ DELAY_INIT_ENTRY
Definition: helics_definitions.hpp:63
@ FORWARD_COMPUTE
Definition: helics_definitions.hpp:56
@ FORCE_LOGGING_FLUSH
Definition: helics_definitions.hpp:69
@ AUTOMATED_TIME_REQUEST
Definition: helics_definitions.hpp:103
@ ONLY_UPDATE_ON_CHANGE
Definition: helics_definitions.hpp:44
@ STRICT_INPUT_TYPE_CHECKING
Definition: helics_definitions.hpp:79
@ IGNORE_INPUT_UNIT_MISMATCH
Definition: helics_definitions.hpp:83
@ ALLOW_REMOTE_CONTROL
Definition: helics_definitions.hpp:96
@ USE_JSON_SERIALIZATION
Definition: helics_definitions.hpp:101
@ RESTRICTIVE_TIME_POLICY
Definition: helics_definitions.hpp:51
@ CONNECTIONS_REQUIRED
Definition: helics_definitions.hpp:75
@ REENTRANT
Definition: helics_definitions.hpp:32
@ INTERRUPTIBLE
Definition: helics_definitions.hpp:26
@ SOURCE_ONLY
Definition: helics_definitions.hpp:38
@ DEBUGGING
Definition: helics_definitions.hpp:71
@ CALLBACK_FEDERATE
Definition: helics_definitions.hpp:93
@ IGNORE_TIME_MISMATCH_WARNINGS
Definition: helics_definitions.hpp:67
@ PROFILING_MARKER
Definition: helics_definitions.hpp:89
@ STRICT_CONFIG_CHECKING
Definition: helics_definitions.hpp:81
@ DISABLE_REMOTE_CONTROL
Definition: helics_definitions.hpp:99
@ LOCAL_PROFILING_CAPTURE
Definition: helics_definitions.hpp:91
@ EVENT_TRIGGERED
Definition: helics_definitions.hpp:85
@ TERMINATE_ON_ERROR
Definition: helics_definitions.hpp:36
@ WAIT_FOR_CURRENT_TIME_UPDATE
Definition: helics_definitions.hpp:47
@ ONLY_TRANSMIT_ON_CHANGE
Definition: helics_definitions.hpp:41
@ UNINTERRUPTIBLE
Definition: helics_definitions.hpp:24
@ REALTIME
Definition: helics_definitions.hpp:58
@ ENABLE_INIT_ENTRY
Definition: helics_definitions.hpp:65
@ ROLLBACK
Definition: helics_definitions.hpp:53
@ OBSERVER
Definition: helics_definitions.hpp:22
@ SLOW_RESPONDING
Definition: helics_definitions.hpp:30
@ SINGLE_THREAD_FEDERATE
Definition: helics_definitions.hpp:60
base helics enumerations for C and C++ API's
@ HELICS_PROPERTY_INT_CURRENT_ITERATION
Definition: helics_enums.h:298
@ HELICS_PROPERTY_INT_LOG_BUFFER
Definition: helics_enums.h:311
@ HELICS_PROPERTY_TIME_RT_LAG
Definition: helics_enums.h:281
@ HELICS_PROPERTY_INT_LOG_LEVEL
Definition: helics_enums.h:303
@ HELICS_PROPERTY_TIME_GRANT_TIMEOUT
Definition: helics_enums.h:296
@ HELICS_PROPERTY_TIME_DELTA
Definition: helics_enums.h:274
@ HELICS_PROPERTY_INT_MAX_ITERATIONS
Definition: helics_enums.h:300
@ HELICS_PROPERTY_TIME_INPUT_DELAY
Definition: helics_enums.h:289
@ HELICS_PROPERTY_TIME_RT_TOLERANCE
Definition: helics_enums.h:287
@ HELICS_PROPERTY_TIME_RT_LEAD
Definition: helics_enums.h:284
@ HELICS_PROPERTY_TIME_PERIOD
Definition: helics_enums.h:276
@ HELICS_PROPERTY_TIME_OUTPUT_DELAY
Definition: helics_enums.h:291
@ HELICS_PROPERTY_INT_CONSOLE_LOG_LEVEL
Definition: helics_enums.h:309
@ HELICS_PROPERTY_TIME_OFFSET
Definition: helics_enums.h:278
@ HELICS_PROPERTY_INT_INDEX_GROUP
Definition: helics_enums.h:313
@ HELICS_PROPERTY_INT_FILE_LOG_LEVEL
Definition: helics_enums.h:306
@ HELICS_PROPERTY_TIME_STOPTIME
Definition: helics_enums.h:293
@ HELICS_OK
Definition: helics_enums.h:262
@ HELICS_ERROR_CONNECTION_FAILURE
Definition: helics_enums.h:258
@ HELICS_ERROR_REGISTRATION_FAILURE
Definition: helics_enums.h:260
@ HELICS_ERROR_OTHER
Definition: helics_enums.h:236
@ HELICS_ERROR_EXECUTION_FAILURE
Definition: helics_enums.h:242
@ HELICS_ERROR_INVALID_ARGUMENT
Definition: helics_enums.h:254
@ HELICS_ERROR_DISCARD
Definition: helics_enums.h:252
@ HELICS_ERROR_SYSTEM_FAILURE
Definition: helics_enums.h:250
@ HELICS_WARNING
Definition: helics_enums.h:248
@ HELICS_ERROR_INVALID_STATE_TRANSITION
Definition: helics_enums.h:246
@ HELICS_ERROR_INVALID_FUNCTION_CALL
Definition: helics_enums.h:244
@ HELICS_ERROR_INVALID_OBJECT
Definition: helics_enums.h:256
@ HELICS_FLAG_ENABLE_INIT_ENTRY
Definition: helics_enums.h:164
@ HELICS_FLAG_DELAY_INIT_ENTRY
Definition: helics_enums.h:162
@ HELICS_FLAG_SOURCE_ONLY
Definition: helics_enums.h:107
@ HELICS_FLAG_ONLY_TRANSMIT_ON_CHANGE
Definition: helics_enums.h:110
@ HELICS_FLAG_STRICT_CONFIG_CHECKING
Definition: helics_enums.h:141
@ HELICS_FLAG_OBSERVER
Definition: helics_enums.h:101
@ HELICS_FLAG_SINGLE_THREAD_FEDERATE
Definition: helics_enums.h:130
@ HELICS_FLAG_REENTRANT
Definition: helics_enums.h:136
@ HELICS_FLAG_AUTOMATED_TIME_REQUEST
Definition: helics_enums.h:155
@ HELICS_FLAG_WAIT_FOR_CURRENT_TIME_UPDATE
Definition: helics_enums.h:116
@ HELICS_FLAG_CALLBACK_FEDERATE
Definition: helics_enums.h:152
@ HELICS_FLAG_ROLLBACK
Definition: helics_enums.h:123
@ HELICS_FLAG_ONLY_UPDATE_ON_CHANGE
Definition: helics_enums.h:113
@ HELICS_FLAG_INTERRUPTIBLE
Definition: helics_enums.h:105
@ HELICS_FLAG_USE_JSON_SERIALIZATION
Definition: helics_enums.h:143
@ HELICS_FLAG_FORWARD_COMPUTE
Definition: helics_enums.h:126
@ HELICS_FLAG_UNINTERRUPTIBLE
Definition: helics_enums.h:103
@ HELICS_FLAG_REALTIME
Definition: helics_enums.h:128
@ HELICS_FLAG_LOCAL_PROFILING_CAPTURE
Definition: helics_enums.h:149
@ HELICS_FLAG_RESTRICTIVE_TIME_POLICY
Definition: helics_enums.h:121
@ HELICS_FLAG_EVENT_TRIGGERED
Definition: helics_enums.h:146
@ HELICS_FLAG_IGNORE_TIME_MISMATCH_WARNINGS
Definition: helics_enums.h:138
@ HELICS_HANDLE_OPTION_CONNECTION_OPTIONAL
Definition: helics_enums.h:350
@ HELICS_HANDLE_OPTION_TIME_RESTRICTED
Definition: helics_enums.h:385
@ HELICS_HANDLE_OPTION_CONNECTION_REQUIRED
Definition: helics_enums.h:347
@ HELICS_HANDLE_OPTION_RECEIVE_ONLY
Definition: helics_enums.h:363
@ HELICS_HANDLE_OPTION_IGNORE_INTERRUPTS
Definition: helics_enums.h:374
@ HELICS_HANDLE_OPTION_CONNECTIONS
Definition: helics_enums.h:383
@ HELICS_HANDLE_OPTION_ONLY_TRANSMIT_ON_CHANGE
Definition: helics_enums.h:370
@ HELICS_HANDLE_OPTION_SINGLE_CONNECTION_ONLY
Definition: helics_enums.h:352
@ HELICS_HANDLE_OPTION_CLEAR_PRIORITY_LIST
Definition: helics_enums.h:380
@ HELICS_HANDLE_OPTION_MULTIPLE_CONNECTIONS_ALLOWED
Definition: helics_enums.h:354
@ HELICS_HANDLE_OPTION_IGNORE_UNIT_MISMATCH
Definition: helics_enums.h:367
@ HELICS_HANDLE_OPTION_MULTI_INPUT_HANDLING_METHOD
Definition: helics_enums.h:376
@ HELICS_HANDLE_OPTION_SOURCE_ONLY
Definition: helics_enums.h:365
@ HELICS_HANDLE_OPTION_ONLY_UPDATE_ON_CHANGE
Definition: helics_enums.h:372
@ HELICS_HANDLE_OPTION_STRICT_TYPE_CHECKING
Definition: helics_enums.h:361
@ HELICS_HANDLE_OPTION_RECONNECTABLE
Definition: helics_enums.h:359
@ HELICS_HANDLE_OPTION_INPUT_PRIORITY_LOCATION
Definition: helics_enums.h:378
@ HELICS_HANDLE_OPTION_BUFFER_DATA
Definition: helics_enums.h:357
@ HELICS_FLAG_DUMPLOG
Definition: helics_enums.h:185
@ HELICS_FLAG_SLOW_RESPONDING
Definition: helics_enums.h:175
@ HELICS_FLAG_PROFILING
Definition: helics_enums.h:187
@ HELICS_FLAG_TERMINATE_ON_ERROR
Definition: helics_enums.h:181
@ HELICS_FLAG_FORCE_LOGGING_FLUSH
Definition: helics_enums.h:183
@ HELICS_FLAG_DISABLE_REMOTE_CONTROL
Definition: helics_enums.h:195
@ HELICS_FLAG_DEBUGGING
Definition: helics_enums.h:179
@ HELICS_FLAG_PROFILING_MARKER
Definition: helics_enums.h:189
@ HELICS_FLAG_ALLOW_REMOTE_CONTROL
Definition: helics_enums.h:192
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
@ PROFILING
profiling log level
Definition: logging.hpp:24
@ WARNING
print/log warning and errors
Definition: logging.hpp:25
@ CONNECTIONS
print summary+federate level connection information
Definition: logging.hpp:27
@ DUMPLOG
only for dumplog
Definition: logging.hpp:21