openswmm_geopackage.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_GEOPACKAGE_H
#define OPENSWMM_GEOPACKAGE_H
 
#include "openswmm_engine_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Opaque handle
 * ========================================================================= */

typedef void* SWMM_Gpkg;
 
/* =========================================================================
 * Return codes
 * ========================================================================= */
 
#define SWMM_GPKG_OK 0   
#define SWMM_GPKG_ERR -1 
 
/* =========================================================================
 * Lifecycle
 * ========================================================================= */

SWMM_ENGINE_API SWMM_Gpkg swmm_gpkg_open(const char* path);

SWMM_ENGINE_API void swmm_gpkg_close(SWMM_Gpkg gpkg);

SWMM_ENGINE_API const char* swmm_gpkg_last_error(SWMM_Gpkg gpkg);
 
/* =========================================================================
 * Transactions
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_begin(SWMM_Gpkg gpkg);

SWMM_ENGINE_API int swmm_gpkg_commit(SWMM_Gpkg gpkg);

SWMM_ENGINE_API int swmm_gpkg_rollback(SWMM_Gpkg gpkg);
 
/* =========================================================================
 * Registration
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_register(const char* license_key, const char* organization,
                                       const char* contact_email, const char* deployment_id);

SWMM_ENGINE_API int swmm_gpkg_is_registered(void);
 
/* =========================================================================
 * Read: Simulation metadata
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_simulation_count(SWMM_Gpkg gpkg);

SWMM_ENGINE_API int swmm_gpkg_simulation_id(SWMM_Gpkg gpkg, int index, char* buf, int bufsz);
 
/* =========================================================================
 * Read: Model object counts
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_node_count(SWMM_Gpkg gpkg, const char* simulation_id);
SWMM_ENGINE_API int swmm_gpkg_link_count(SWMM_Gpkg gpkg, const char* simulation_id);
SWMM_ENGINE_API int swmm_gpkg_subcatch_count(SWMM_Gpkg gpkg, const char* simulation_id);
SWMM_ENGINE_API int swmm_gpkg_gage_count(SWMM_Gpkg gpkg, const char* simulation_id);
SWMM_ENGINE_API int swmm_gpkg_topology_edge_count(SWMM_Gpkg gpkg, const char* simulation_id);
SWMM_ENGINE_API int swmm_gpkg_variable_count(SWMM_Gpkg gpkg);
 
/* =========================================================================
 * Read: Simulation result timeseries
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_read_result_ts(SWMM_Gpkg gpkg, const char* simulation_id,
                                             const char* object_type, const char* object_id,
                                             const char* variable_name, double* times,
                                             double* values, int max_count);

SWMM_ENGINE_API int swmm_gpkg_result_ts_count(SWMM_Gpkg gpkg, const char* simulation_id,
                                              const char* object_type, const char* object_id,
                                              const char* variable_name);
 
/* =========================================================================
 * Read: Summary statistics
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_read_summary(SWMM_Gpkg gpkg, const char* simulation_id,
                                           const char* object_type, const char* object_id,
                                           const char* variable_name, double* value);
 
/* =========================================================================
 * Write: Observed / sensor timeseries
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_create_observed_series(SWMM_Gpkg gpkg, const char* name,
                                                     const char* variable_name,
                                                     const char* object_type, const char* object_id,
                                                     const char* source, const char* units);

SWMM_ENGINE_API int swmm_gpkg_write_observed_value(SWMM_Gpkg gpkg, int series_id,
                                                   const char* timestamp, double value,
                                                   const char* quality_flag);

SWMM_ENGINE_API int swmm_gpkg_write_observed_values(SWMM_Gpkg gpkg, int series_id,
                                                    const char** timestamps, const double* values,
                                                    const char** quality_flags, int count);
 
/* =========================================================================
 * Read: Observed / sensor timeseries
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_observed_series_count(SWMM_Gpkg gpkg);

SWMM_ENGINE_API int swmm_gpkg_observed_value_count(SWMM_Gpkg gpkg, int series_id);

SWMM_ENGINE_API int swmm_gpkg_read_observed_values(SWMM_Gpkg gpkg, int series_id, char* timestamps,
                                                   int ts_buf_len, double* values, int max_count);
 
/* =========================================================================
 * Read: Ad-hoc queries
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gpkg_query_int(SWMM_Gpkg gpkg, const char* sql);

SWMM_ENGINE_API int swmm_gpkg_query_double(SWMM_Gpkg gpkg, const char* sql, double* result);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMM_GEOPACKAGE_H */