api-data.h

Go to the documentation of this file.

/*
Copyright (c) 2017-2025,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See the top-level NOTICE for
additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
 
#ifndef HELICS_API_DATA_H_
#define HELICS_API_DATA_H_
 
#include "../helics_enums.h"
 
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* HelicsInput;
// typedef void* helics_input;
typedef void* HelicsPublication;
// typedef void* helics_publication;
// typedef void* helics_endpoint;
typedef void* HelicsEndpoint;
 
// typedef void* helics_filter;
typedef void* HelicsFilter;
 
typedef void* HelicsTranslator;
 
// typedef void* helics_core;
typedef void* HelicsCore;
 
// typedef void* helics_broker;
typedef void* HelicsBroker;
// typedef void* helics_federate;
typedef void* HelicsFederate;
 
// typedef void* helics_federate;
typedef void* HelicsApp;
 
// typedef void* helics_federate_info;
typedef void* HelicsFederateInfo;
 
// typedef void* helics_query;
typedef void* HelicsQuery;
 
typedef void* HelicsDataBuffer;
 
// typedef void* helics_query_buffer;
typedef void* HelicsQueryBuffer;
 
// typedef void* helics_message;
typedef void* HelicsMessage;
 
// typedef double helics_time;
typedef double HelicsTime;
 
const HelicsTime HELICS_TIME_ZERO = 0.0; 
const HelicsTime HELICS_TIME_EPSILON = 1.0e-9; 
const HelicsTime HELICS_TIME_INVALID = -1.785e39; 
const HelicsTime HELICS_TIME_MAXTIME = HELICS_BIG_NUMBER; 
// typedef int helics_bool;
typedef int HelicsBool;
 
const HelicsBool HELICS_TRUE = 1; 
const HelicsBool HELICS_FALSE = 0; 
typedef enum {
    HELICS_ITERATION_REQUEST_NO_ITERATION = 0, 
    HELICS_ITERATION_REQUEST_FORCE_ITERATION = 1, 
    HELICS_ITERATION_REQUEST_ITERATE_IF_NEEDED = 2, 
    HELICS_ITERATION_REQUEST_HALT_OPERATIONS = 5, 
    HELICS_ITERATION_REQUEST_ERROR = 7 
} HelicsIterationRequest;
 
typedef enum {
    HELICS_ITERATION_RESULT_NEXT_STEP = 0, 
    HELICS_ITERATION_RESULT_ERROR = 1, 
    HELICS_ITERATION_RESULT_HALTED = 2, 
    HELICS_ITERATION_RESULT_ITERATING = 3 
} HelicsIterationResult;
 
typedef enum {
    HELICS_STATE_UNKNOWN = -1, 
    HELICS_STATE_STARTUP = 0, 
    HELICS_STATE_INITIALIZATION = 1, 
    HELICS_STATE_EXECUTION = 2, 
    HELICS_STATE_FINALIZE = 3, 
    HELICS_STATE_ERROR = 4, 
    /* the following states are for asynchronous operations */
    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 
} HelicsFederateState;
 
typedef struct HelicsComplex {
    double real;
    double imag;
} HelicsComplex;
 
typedef struct HelicsError {
    int32_t error_code; 
    const char* message; 
} HelicsError;
 
// typedef helics_error HelicsError;
 
#ifdef __cplusplus
} /* end of extern "C" { */
#endif
 
#endif