helics  2.8.1
api-data.h
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 Energy, LLC. See the top-level NOTICE for
4 additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 
8 #ifndef HELICS_API_DATA_H_
9 #define HELICS_API_DATA_H_
10 
16 #include "../helics_enums.h"
17 
18 #include <stdint.h>
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
26 typedef void* helics_input;
27 
31 typedef void* helics_publication;
32 
36 typedef void* helics_endpoint;
37 
41 typedef void* helics_filter;
42 
46 typedef void* helics_core;
47 
51 typedef void* helics_broker;
52 
56 typedef void* helics_federate;
57 
61 typedef void* helics_federate_info;
62 
66 typedef void* helics_query;
67 
71 typedef void* helics_query_buffer;
72 
76 typedef void* helics_message_object;
77 
81 typedef double helics_time;
82 
85 const helics_time helics_time_invalid = -1.785e39;
86 const helics_time helics_time_maxtime = 9223372036.854774;
92 typedef int helics_bool;
93 
100 typedef enum {
105 
109 typedef enum {
115 
119 typedef enum {
125  /* the following states are for asynchronous operations */
133 
137 typedef struct helics_complex {
138  double real;
139  double imag;
141 
147 typedef struct helics_message {
149  const char* data;
150  int64_t length;
151  int32_t messageID;
152  int16_t flags;
153  const char* original_source;
154  const char* source;
155  const char* dest;
156  const char* original_dest;
159 
166 typedef struct helics_error {
167  int32_t error_code;
168  const char* message;
169 } helics_error;
170 
171 #ifdef __cplusplus
172 } /* end of extern "C" { */
173 #endif
174 
175 #endif
helics_iteration_request_force_iteration
@ helics_iteration_request_force_iteration
Definition: api-data.h:102
helics_state_pending_time
@ helics_state_pending_time
Definition: api-data.h:128
helics_message::original_source
const char * original_source
Definition: api-data.h:153
helics_time_zero
const helics_time helics_time_zero
Definition: api-data.h:83
helics_time_epsilon
const helics_time helics_time_epsilon
Definition: api-data.h:84
helics_state_finalize
@ helics_state_finalize
Definition: api-data.h:123
helics_message_object
void * helics_message_object
Definition: api-data.h:76
helics_iteration_request_no_iteration
@ helics_iteration_request_no_iteration
Definition: api-data.h:101
helics_publication
void * helics_publication
Definition: api-data.h:31
helics_time
double helics_time
Definition: api-data.h:81
helics_core
void * helics_core
Definition: api-data.h:46
helics_query
void * helics_query
Definition: api-data.h:66
helics_iteration_request
helics_iteration_request
Definition: api-data.h:100
helics_state_pending_init
@ helics_state_pending_init
Definition: api-data.h:126
helics_state_error
@ helics_state_error
Definition: api-data.h:124
helics_false
const helics_bool helics_false
Definition: api-data.h:95
helics_state_startup
@ helics_state_startup
Definition: api-data.h:120
helics_true
const helics_bool helics_true
Definition: api-data.h:94
helics_message::messageID
int32_t messageID
Definition: api-data.h:151
helics_message
Definition: api-data.h:147
helics_filter
void * helics_filter
Definition: api-data.h:41
helics_state_execution
@ helics_state_execution
Definition: api-data.h:122
helics_federate_state
helics_federate_state
Definition: api-data.h:119
helics_complex
Definition: api-data.h:137
helics_iteration_result_error
@ helics_iteration_result_error
Definition: api-data.h:111
helics_time_maxtime
const helics_time helics_time_maxtime
Definition: api-data.h:86
helics_time_invalid
const helics_time helics_time_invalid
Definition: api-data.h:85
helics_query_buffer
void * helics_query_buffer
Definition: api-data.h:71
helics_endpoint
void * helics_endpoint
Definition: api-data.h:36
helics_message::length
int64_t length
Definition: api-data.h:150
helics_state_finished
@ helics_state_finished
Definition: api-data.h:131
helics_iteration_result_halted
@ helics_iteration_result_halted
Definition: api-data.h:112
helics_message::source
const char * source
Definition: api-data.h:154
helics_message::flags
int16_t flags
Definition: api-data.h:152
helics_state_initialization
@ helics_state_initialization
Definition: api-data.h:121
helics_iteration_result_next_step
@ helics_iteration_result_next_step
Definition: api-data.h:110
helics_state_pending_iterative_time
@ helics_state_pending_iterative_time
Definition: api-data.h:129
helics_iteration_request_iterate_if_needed
@ helics_iteration_request_iterate_if_needed
Definition: api-data.h:103
helics_error
Definition: api-data.h:166
helics_iteration_result_iterating
@ helics_iteration_result_iterating
Definition: api-data.h:113
helics_federate_info
void * helics_federate_info
Definition: api-data.h:61
helics_message::original_dest
const char * original_dest
Definition: api-data.h:156
helics_error::error_code
int32_t error_code
Definition: api-data.h:167
helics_complex
struct helics_complex helics_complex
helics_broker
void * helics_broker
Definition: api-data.h:51
helics_state_pending_exec
@ helics_state_pending_exec
Definition: api-data.h:127
helics_input
void * helics_input
Definition: api-data.h:26
helics_message::data
const char * data
Definition: api-data.h:149
helics_error::message
const char * message
Definition: api-data.h:168
helics_bool
int helics_bool
Definition: api-data.h:92
helics_message::dest
const char * dest
Definition: api-data.h:155
helics_message::time
helics_time time
Definition: api-data.h:148
helics_state_pending_finalize
@ helics_state_pending_finalize
Definition: api-data.h:130
helics_message
struct helics_message helics_message
helics_error
struct helics_error helics_error
helics_federate
void * helics_federate
Definition: api-data.h:56
helics_iteration_result
helics_iteration_result
Definition: api-data.h:109