![]() |
helics
2.8.1
|
Data structures for the C api. More...
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 |
Data structures for the C api.
typedef int helics_bool |
defining a boolean type for use in the helics interface
typedef void* helics_broker |
opaque object representing a broker
typedef struct helics_complex helics_complex |
structure defining a basic complex type
typedef void* helics_core |
opaque object representing a core
typedef void* helics_endpoint |
opaque object representing an endpoint
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
typedef void* helics_federate |
opaque object representing a federate
typedef void* helics_federate_info |
opaque object representing a filter info object structure
typedef void* helics_filter |
opaque object representing a filter
typedef void* helics_input |
opaque object representing an input
typedef struct helics_message 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
typedef void* helics_message_object |
opaque object representing a message
typedef void* helics_publication |
opaque object representing a publication
typedef void* helics_query |
opaque object representing a query
typedef void* helics_query_buffer |
opaque object representing a string buffer for a query
typedef double helics_time |
time definition used in the C interface to helics
enumeration of possible federate states
enumeration of possible return values from an iterative time request
const helics_bool helics_false = 0 |
indicator used for a false response
Referenced by helicscpp::Federate::getFlagOption(), helicsBrokerIsConnected(), helicsBrokerIsValid(), helicsBrokerWaitForDisconnect(), helicsCoreConnect(), helicsCoreIsConnected(), helicsCoreIsValid(), helicsCoreWaitForDisconnect(), helicsInputGetBoolean(), helicsInputGetOption(), helicsInputIsUpdated(), helicsInputIsValid(), helicsInputSetDefaultBoolean(), helicsIsCoreTypeAvailable(), helicsPublicationGetOption(), helicsPublicationIsValid(), helicsPublicationPublishBoolean(), helicscpp::Core::isConnected(), helicscpp::Broker::isConnected(), helicscpp::Publication::publish(), helicscpp::Input::setDefault(), helicscpp::Message::setFlag(), helicscpp::FederateInfo::setFlagOption(), helicscpp::Federate::setFlagOption(), helicscpp::Core::waitForDisconnect(), and helicscpp::Broker::waitForDisconnect().
const helics_time helics_time_epsilon = 1.0e-9 |
definition of the minimum time resolution
const helics_time helics_time_invalid = -1.785e39 |
definition of an invalid time that has no meaning
Referenced by helicsInputGetComplexObject(), helicsInputGetDouble(), helicsInputGetTime(), and helicsInputLastUpdateTime().
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
const helics_time helics_time_zero = 0.0 |
definition of time zero-the beginning of simulation
const helics_bool helics_true = 1 |
indicator used for a true response
Referenced by helicscpp::Broker::Broker(), helicscpp::Message::checkFlag(), helicscpp::Input::getBoolean(), helicsBrokerIsConnected(), helicsBrokerIsValid(), helicsBrokerWaitForDisconnect(), helicsCoreConnect(), helicsCoreIsConnected(), helicsCoreIsValid(), helicsCoreWaitForDisconnect(), helicsInputGetBoolean(), helicsInputIsUpdated(), helicsInputIsValid(), helicsIsCoreTypeAvailable(), helicsPublicationIsValid(), helicscpp::Input::isValid(), helicscpp::Filter::isValid(), helicscpp::Publication::isValid(), helicscpp::Message::isValid(), helicscpp::Endpoint::isValid(), helicscpp::Publication::publish(), helicscpp::Input::setDefault(), helicscpp::Message::setFlag(), helicscpp::FederateInfo::setFlagOption(), and helicscpp::Federate::setFlagOption().