openswmm_output2d.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright 2026 Caleb Buahin */
 
#ifndef OPENSWMM_OUTPUT2D_H
#define OPENSWMM_OUTPUT2D_H
#include "openswmm_engine_export.h"
#include <stddef.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* SWMM_Output2D;

SWMM_ENGINE_API int swmm_output2d_available(void);

SWMM_ENGINE_API int swmm_output2d_open(const char* path, SWMM_Output2D* output);

SWMM_ENGINE_API void swmm_output2d_close(SWMM_Output2D output);

SWMM_ENGINE_API const char* swmm_output2d_error(void);

SWMM_ENGINE_API int swmm_output2d_datasets(SWMM_Output2D output, char* text, size_t capacity,
                                           size_t* required);

SWMM_ENGINE_API int swmm_output2d_shape(SWMM_Output2D output, const char* dataset, int* rank,
                                        uint64_t* dimensions, int* integer,
                                        uint64_t* unlimited_axes);

SWMM_ENGINE_API int swmm_output2d_attributes(SWMM_Output2D output, const char* object, char* text,
                                             size_t capacity, size_t* required);

SWMM_ENGINE_API int swmm_output2d_attribute(SWMM_Output2D output, const char* object,
                                            const char* name, char* text, size_t capacity,
                                            size_t* required);

SWMM_ENGINE_API int swmm_output2d_strings(SWMM_Output2D output, const char* dataset, char* text,
                                          size_t capacity, size_t* required);

SWMM_ENGINE_API int swmm_output2d_read_double(SWMM_Output2D output, const char* dataset,
                                              const uint64_t* start, const uint64_t* count,
                                              const uint64_t* stride, double* values,
                                              size_t capacity);

SWMM_ENGINE_API int swmm_output2d_read_int64(SWMM_Output2D output, const char* dataset,
                                             const uint64_t* start, const uint64_t* count,
                                             const uint64_t* stride, int64_t* values,
                                             size_t capacity);
 
#ifdef __cplusplus
}
#endif
#endif