helics  2.8.1
Classes | Typedefs | Enumerations | Variables
api-data.h File Reference

Data structures for the C api. More...

#include "../helics_enums.h"
#include <stdint.h>

Go to the source code of this file.

Classes

struct  helics_complex
 
struct  helics_message
 
struct  helics_error
 

Typedefs

typedef void * helics_input
 
typedef void * helics_publication
 
typedef void * helics_endpoint
 
typedef void * helics_filter
 
typedef void * helics_core
 
typedef void * helics_broker
 
typedef void * helics_federate
 
typedef void * helics_federate_info
 
typedef void * helics_query
 
typedef void * helics_query_buffer
 
typedef void * helics_message_object
 
typedef double helics_time
 
typedef int helics_bool
 
typedef struct helics_complex helics_complex
 
typedef struct helics_message helics_message
 
typedef struct helics_error helics_error
 

Enumerations

enum  helics_iteration_request { helics_iteration_request_no_iteration = 0, helics_iteration_request_force_iteration = 1, helics_iteration_request_iterate_if_needed = 2 }
 
enum  helics_iteration_result { helics_iteration_result_next_step = 0, helics_iteration_result_error = 1, helics_iteration_result_halted = 2, helics_iteration_result_iterating = 3 }
 
enum  helics_federate_state {
  helics_state_startup = 0, helics_state_initialization = 1, helics_state_execution = 2, helics_state_finalize = 3,
  helics_state_error = 4, helics_state_pending_init = 5, helics_state_pending_exec = 6, helics_state_pending_time = 7,
  helics_state_pending_iterative_time = 8, helics_state_pending_finalize = 9, helics_state_finished = 10
}
 

Variables

const helics_time helics_time_zero = 0.0
 
const helics_time helics_time_epsilon = 1.0e-9
 
const helics_time helics_time_invalid = -1.785e39
 
const helics_time helics_time_maxtime = 9223372036.854774
 
const helics_bool helics_true = 1
 
const helics_bool helics_false = 0
 

Detailed Description

Data structures for the C api.

Typedef Documentation

◆ helics_bool

typedef int helics_bool

defining a boolean type for use in the helics interface

◆ helics_broker

typedef void* helics_broker

opaque object representing a broker

◆ helics_complex

structure defining a basic complex type

◆ helics_core

typedef void* helics_core

opaque object representing a core

◆ helics_endpoint

typedef void* helics_endpoint

opaque object representing an endpoint

◆ helics_error

typedef struct helics_error helics_error

helics error object

if error_code==0 there is no error, if error_code!=0 there is an error and message will contain a string, otherwise it will be an empty string

◆ helics_federate

typedef void* helics_federate

opaque object representing a federate

◆ helics_federate_info

typedef void* helics_federate_info

opaque object representing a filter info object structure

◆ helics_filter

typedef void* helics_filter

opaque object representing a filter

◆ helics_input

typedef void* helics_input

opaque object representing an input

◆ helics_message

Message_t mapped to a c compatible structure

use of this structure is deprecated in HELICS 2.5 and removed in HELICS 3.0

◆ helics_message_object

typedef void* helics_message_object

opaque object representing a message

◆ helics_publication

typedef void* helics_publication

opaque object representing a publication

◆ helics_query

typedef void* helics_query

opaque object representing a query

◆ helics_query_buffer

typedef void* helics_query_buffer

opaque object representing a string buffer for a query

◆ helics_time

typedef double helics_time

time definition used in the C interface to helics

Enumeration Type Documentation

◆ helics_federate_state

enumeration of possible federate states

Enumerator
helics_state_startup 

when created the federate is in startup state

helics_state_initialization 

entered after the enterInitializingMode call has returned

helics_state_execution 

entered after the enterExectuationState call has returned

helics_state_finalize 

the federate has finished executing normally final values may be retrieved

helics_state_error 

error state no core communication is possible but values can be retrieved

helics_state_pending_init 

indicator that the federate is pending entry to initialization state

helics_state_pending_exec 

state pending EnterExecution State

helics_state_pending_time 

state that the federate is pending a timeRequest

helics_state_pending_iterative_time 

state that the federate is pending an iterative time request

helics_state_pending_finalize 

state that the federate is pending a finalize request

helics_state_finished 

state that the federate is finished simulating but still connected

◆ helics_iteration_request

enumeration of the different iteration results

Enumerator
helics_iteration_request_no_iteration 

no iteration is requested

helics_iteration_request_force_iteration 

force iteration return when able

helics_iteration_request_iterate_if_needed 

only return an iteration if necessary

◆ helics_iteration_result

enumeration of possible return values from an iterative time request

Enumerator
helics_iteration_result_next_step 

the iterations have progressed to the next time

helics_iteration_result_error 

there was an error

helics_iteration_result_halted 

the federation has halted

helics_iteration_result_iterating 

the federate is iterating at current time

Variable Documentation

◆ helics_false

const helics_bool helics_false = 0

◆ helics_time_epsilon

const helics_time helics_time_epsilon = 1.0e-9

definition of the minimum time resolution

◆ helics_time_invalid

const helics_time helics_time_invalid = -1.785e39

definition of an invalid time that has no meaning

Referenced by helicsInputGetComplexObject(), helicsInputGetDouble(), helicsInputGetTime(), and helicsInputLastUpdateTime().

◆ helics_time_maxtime

const helics_time helics_time_maxtime = 9223372036.854774

definition of time signifying the federate has terminated or to run until the end of the simulation

◆ helics_time_zero

const helics_time helics_time_zero = 0.0

definition of time zero-the beginning of simulation

◆ helics_true

const helics_bool helics_true = 1