helics  2.8.1
helics_definitions.hpp
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2021,
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
8 
12 #include "helics/helics_enums.h"
13 
14 namespace helics {
18 namespace defs {
20  enum flags : int32_t {
90  };
92  enum errors : int32_t {
93 
114  };
115 
117  enum properties : int32_t {
118  time_delta = helics_property_time_delta,
123  rt_tolerance = helics_property_time_rt_tolerance,
124  input_delay = helics_property_time_input_delay,
125  output_delay = helics_property_time_output_delay,
126  max_iterations = helics_property_int_max_iterations,
128  file_log_level = helics_property_int_file_log_level,
129  console_log_level = helics_property_int_console_log_level
130  };
131 
133  enum options : int32_t {
134  connection_required = helics_handle_option_connection_required,
135  connection_optional = helics_handle_option_connection_optional,
136  single_connection_only = helics_handle_option_single_connection_only,
137  multiple_connections_allowed = helics_handle_option_multiple_connections_allowed,
138  handle_only_transmit_on_change = helics_handle_option_only_transmit_on_change,
139  handle_only_update_on_change = helics_handle_option_only_update_on_change,
140  buffer_data = helics_handle_option_buffer_data,
141  ignore_interrupts = helics_handle_option_ignore_interrupts,
142  strict_type_checking = helics_handle_option_strict_type_checking,
143  ignore_unit_mismatch = helics_handle_option_ignore_unit_mismatch,
144  multi_input_handling_method = helics_handle_option_multi_input_handling_method,
145  input_priority_location = helics_handle_option_input_priority_location,
146  clear_priority_list = helics_handle_option_clear_priority_list,
148  };
149 
150 } // namespace defs
151 } // namespace helics
helics_error_execution_failure
@ helics_error_execution_failure
Definition: helics_enums.h:195
helics_property_time_offset
@ helics_property_time_offset
Definition: helics_enums.h:219
helics::defs::profiling
@ profiling
Definition: helics_definitions.hpp:85
helics::defs::realtime
@ realtime
Definition: helics_definitions.hpp:56
helics_property_int_max_iterations
@ helics_property_int_max_iterations
Definition: helics_enums.h:234
helics::defs::system_failure
@ system_failure
Definition: helics_definitions.hpp:103
helics::defs::profiling_marker
@ profiling_marker
Definition: helics_definitions.hpp:87
helics::defs::properties
properties
Definition: helics_definitions.hpp:117
helics_flag_single_thread_federate
@ helics_flag_single_thread_federate
Definition: helics_enums.h:114
connections
@ connections
print summary+ federate level connection information
Definition: loggingHelper.hpp:25
helics_flag_event_triggered
@ helics_flag_event_triggered
Definition: helics_enums.h:124
helics_property_time_rt_lag
@ helics_property_time_rt_lag
Definition: helics_enums.h:222
helics_property_time_input_delay
@ helics_property_time_input_delay
Definition: helics_enums.h:230
helics_handle_option_multiple_connections_allowed
@ helics_handle_option_multiple_connections_allowed
Definition: helics_enums.h:283
helics::defs::connection_failure
@ connection_failure
Definition: helics_definitions.hpp:96
helics_error_invalid_object
@ helics_error_invalid_object
Definition: helics_enums.h:206
helics_warning
@ helics_warning
Definition: helics_enums.h:200
helics_handle_option_connection_required
@ helics_handle_option_connection_required
Definition: helics_enums.h:276
warning
@ warning
print/log warning and errors
Definition: loggingHelper.hpp:23
helics::defs::debugging
@ debugging
Definition: helics_definitions.hpp:69
helics_handle_option_clear_priority_list
@ helics_handle_option_clear_priority_list
Definition: helics_enums.h:302
helics_error_invalid_state_transition
@ helics_error_invalid_state_transition
Definition: helics_enums.h:198
helics_property_time_output_delay
@ helics_property_time_output_delay
Definition: helics_enums.h:232
helics::defs::force_logging_flush
@ force_logging_flush
Definition: helics_definitions.hpp:67
helics_handle_option_strict_type_checking
@ helics_handle_option_strict_type_checking
Definition: helics_enums.h:287
helics::defs::invalid_state_transition
@ invalid_state_transition
Definition: helics_definitions.hpp:106
helics::defs::wait_for_current_time_update
@ wait_for_current_time_update
Definition: helics_definitions.hpp:45
helics_error_discard
@ helics_error_discard
Definition: helics_enums.h:203
helics_property_time_rt_lead
@ helics_property_time_rt_lead
Definition: helics_enums.h:225
helics_flag_force_logging_flush
@ helics_flag_force_logging_flush
Definition: helics_enums.h:155
helics_flag_dumplog
@ helics_flag_dumplog
Definition: helics_enums.h:157
helics_handle_option_buffer_data
@ helics_handle_option_buffer_data
Definition: helics_enums.h:285
helics_flag_debugging
@ helics_flag_debugging
Definition: helics_enums.h:151
helics_error_system_failure
@ helics_error_system_failure
Definition: helics_enums.h:201
helics::defs::enable_init_entry
@ enable_init_entry
Definition: helics_definitions.hpp:63
helics_flag_ignore_time_mismatch_warnings
@ helics_flag_ignore_time_mismatch_warnings
Definition: helics_enums.h:116
helics_property_int_console_log_level
@ helics_property_int_console_log_level
Definition: helics_enums.h:242
helics_handle_option_multi_input_handling_method
@ helics_handle_option_multi_input_handling_method
Definition: helics_enums.h:298
helics_error_registration_failure
@ helics_error_registration_failure
Definition: helics_enums.h:208
helics::defs::strict_input_type_checking
@ strict_input_type_checking
Definition: helics_definitions.hpp:77
helics::defs::source_only
@ source_only
Definition: helics_definitions.hpp:36
helics_handle_option_single_connection_only
@ helics_handle_option_single_connection_only
Definition: helics_enums.h:281
helics_property_time_delta
@ helics_property_time_delta
Definition: helics_enums.h:215
helics_error_invalid_argument
@ helics_error_invalid_argument
Definition: helics_enums.h:204
helics_handle_option_connection_optional
@ helics_handle_option_connection_optional
Definition: helics_enums.h:279
helics_flag_enable_init_entry
@ helics_flag_enable_init_entry
Definition: helics_enums.h:137
helics_property_time_rt_tolerance
@ helics_property_time_rt_tolerance
Definition: helics_enums.h:228
defs
helics::defs::ignore_input_unit_mismatch
@ ignore_input_unit_mismatch
Definition: helics_definitions.hpp:81
helics_enums.h
base helics enumerations for C and C++ API's
helics::defs::uninterruptible
@ uninterruptible
Definition: helics_definitions.hpp:24
helics_flag_profiling
@ helics_flag_profiling
Definition: helics_enums.h:159
helics::defs::connections_required
@ connections_required
Definition: helics_definitions.hpp:73
helics_flag_wait_for_current_time_update
@ helics_flag_wait_for_current_time_update
Definition: helics_enums.h:101
helics::defs::rollback
@ rollback
Definition: helics_definitions.hpp:51
helics_handle_option_only_transmit_on_change
@ helics_handle_option_only_transmit_on_change
Definition: helics_enums.h:292
helics_flag_source_only
@ helics_flag_source_only
Definition: helics_enums.h:92
helics_handle_option_only_update_on_change
@ helics_handle_option_only_update_on_change
Definition: helics_enums.h:294
helics::defs::discard
@ discard
Definition: helics_definitions.hpp:102
helics_property_int_file_log_level
@ helics_property_int_file_log_level
Definition: helics_enums.h:239
helics_flag_restrictive_time_policy
@ helics_flag_restrictive_time_policy
Definition: helics_enums.h:106
helics_property_int_log_level
@ helics_property_int_log_level
Definition: helics_enums.h:236
helics::defs::only_update_on_change
@ only_update_on_change
Definition: helics_definitions.hpp:42
helics::defs::invalid_object
@ invalid_object
Definition: helics_definitions.hpp:98
helics::defs::strict_config_checking
@ strict_config_checking
Definition: helics_definitions.hpp:79
helics_flag_forward_compute
@ helics_flag_forward_compute
Definition: helics_enums.h:110
helics_error_other
@ helics_error_other
Definition: helics_enums.h:190
helics_flag_strict_config_checking
@ helics_flag_strict_config_checking
Definition: helics_enums.h:119
helics::defs::delay_init_entry
@ delay_init_entry
Definition: helics_definitions.hpp:61
helics::defs::local_profiling_capture
@ local_profiling_capture
Definition: helics_definitions.hpp:89
helics::defs::terminate_on_error
@ terminate_on_error
Definition: helics_definitions.hpp:34
helics_handle_option_ignore_unit_mismatch
@ helics_handle_option_ignore_unit_mismatch
Definition: helics_enums.h:289
helics::defs::dumplog
@ dumplog
Definition: helics_definitions.hpp:71
helics_flag_interruptible
@ helics_flag_interruptible
Definition: helics_enums.h:90
helics_flag_uninterruptible
@ helics_flag_uninterruptible
Definition: helics_enums.h:88
helics_flag_local_profiling_capture
@ helics_flag_local_profiling_capture
Definition: helics_enums.h:129
helics_flag_slow_responding
@ helics_flag_slow_responding
Definition: helics_enums.h:147
helics::defs::single_thread_federate
@ single_thread_federate
Definition: helics_definitions.hpp:58
helics::defs::registration_failure
@ registration_failure
Definition: helics_definitions.hpp:95
helics_flag_delay_init_entry
@ helics_flag_delay_init_entry
Definition: helics_enums.h:135
helics::defs::forward_compute
@ forward_compute
Definition: helics_definitions.hpp:54
log_level
log_level
Definition: loggingHelper.hpp:20
helics::defs::ok
@ ok
Definition: helics_definitions.hpp:94
helics_error_connection_failure
@ helics_error_connection_failure
Definition: helics_enums.h:207
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics_flag_only_update_on_change
@ helics_flag_only_update_on_change
Definition: helics_enums.h:98
helics_flag_only_transmit_on_change
@ helics_flag_only_transmit_on_change
Definition: helics_enums.h:95
helics_flag_realtime
@ helics_flag_realtime
Definition: helics_enums.h:112
helics::defs::slow_responding
@ slow_responding
Definition: helics_definitions.hpp:30
helics_flag_terminate_on_error
@ helics_flag_terminate_on_error
Definition: helics_enums.h:153
helics::defs::invalid_function_call
@ invalid_function_call
Definition: helics_definitions.hpp:109
helics::defs::ignore_time_mismatch_warnings
@ ignore_time_mismatch_warnings
Definition: helics_definitions.hpp:65
helics::defs::connections_optional
@ connections_optional
Definition: helics_definitions.hpp:75
helics_flag_observer
@ helics_flag_observer
Definition: helics_enums.h:86
helics_ok
@ helics_ok
Definition: helics_enums.h:209
helics::defs::invalid_argument
@ invalid_argument
Definition: helics_definitions.hpp:100
helics::defs::event_triggered
@ event_triggered
Definition: helics_definitions.hpp:83
helics_handle_option_ignore_interrupts
@ helics_handle_option_ignore_interrupts
Definition: helics_enums.h:296
helics::defs::flags
flags
Definition: helics_definitions.hpp:20
helics::defs::errors
errors
Definition: helics_definitions.hpp:92
helics::defs::execution_failure
@ execution_failure
Definition: helics_definitions.hpp:112
helics_flag_rollback
@ helics_flag_rollback
Definition: helics_enums.h:108
helics::defs::options
options
Definition: helics_definitions.hpp:133
helics::defs::only_transmit_on_change
@ only_transmit_on_change
Definition: helics_definitions.hpp:39
helics::defs::other
@ other
Definition: helics_definitions.hpp:113
helics_handle_option_input_priority_location
@ helics_handle_option_input_priority_location
Definition: helics_enums.h:300
helics_property_time_period
@ helics_property_time_period
Definition: helics_enums.h:217
helics_handle_option_connections
@ helics_handle_option_connections
Definition: helics_enums.h:304
helics_error_invalid_function_call
@ helics_error_invalid_function_call
Definition: helics_enums.h:196
helics::defs::restrictive_time_policy
@ restrictive_time_policy
Definition: helics_definitions.hpp:49
helics::defs::observer
@ observer
Definition: helics_definitions.hpp:22
helics::defs::interruptible
@ interruptible
Definition: helics_definitions.hpp:26
helics_flag_profiling_marker
@ helics_flag_profiling_marker
Definition: helics_enums.h:126