openswmm_model.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_MODEL_H
#define OPENSWMM_MODEL_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Model building — programmatic construction (state guard: BUILDING only)
 * ========================================================================= */
 
SWMM_ENGINE_API SWMM_Engine swmm_engine_new(void);
 
/* =========================================================================
 * Model finalisation and validation
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_validate_model(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_finalize_model(SWMM_Engine engine);
 
/* =========================================================================
 * Model serialisation
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_model_write(SWMM_Engine engine, const char* new_inp_path);
 
SWMM_ENGINE_API int
swmm_model_write_with_plugin(SWMM_Engine engine,
                              const char* new_path,
                              const char* output_plugin_id);
 
/* =========================================================================
 * [PLUGINS] section access (Slice AA-3.1 Phase B)
 *
 * The [PLUGINS] section of an .inp file is a list of rows, one per
 * plugin to load.  Each row is `path arg1 arg2 …` where `path` resolves
 * via the same logic as the input plugin lib (a library path, an id, or
 * an `id:version` pair) and the trailing tokens are passed to the
 * plugin's initialize() method as `init_args`.
 *
 * The accessors below let a host (GUI) read, mutate, and remove rows
 * without re-parsing the .inp file.  Plugins themselves are
 * (re-)resolved by PluginFactory at swmm_engine_open / swmm_model_write
 * time — these accessors only mutate the in-memory `plugin_specs` list.
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_plugins_count(SWMM_Engine engine, int* count);
 
SWMM_ENGINE_API int
swmm_plugin_get(SWMM_Engine engine,
                int          idx,
                char*        path_buf,
                int          path_buf_sz,
                char*        args_buf,
                int          args_buf_sz);
 
SWMM_ENGINE_API int
swmm_plugin_set(SWMM_Engine engine,
                const char*  path_or_id,
                const char*  args);
 
SWMM_ENGINE_API int
swmm_plugin_remove(SWMM_Engine engine, const char* path_or_id);
 
/* =========================================================================
 * [FILES] section access (Slice AA-3 follow-up — secondary file refs)
 *
 * Read / write the legacy SWMM5 `[FILES]` section: rainfall, runoff,
 * RDII, inflows, outflows, and hot-start file references.  The
 * accessors are keyed by an uppercase string so callers don't depend
 * on the field layout of `FilesSpec`.
 *
 * Recognised keys (case-insensitive):
 *   "RAINFALL_PATH"          / "RAINFALL_MODE"
 *   "RUNOFF_PATH"            / "RUNOFF_MODE"
 *   "RDII_PATH"              / "RDII_MODE"
 *   "INFLOWS_PATH"
 *   "OUTFLOWS_PATH"
 *   "HOTSTART_USE_PATH"
 *   "HOTSTART_SAVE_PATH"     / "HOTSTART_SAVE_DATETIME"
 *
 * `*_MODE` keys take "SAVE" / "USE" / "" (empty clears the slot).
 * `HOTSTART_SAVE_DATETIME` is a SWMM decimal-day floating-point string
 * (0 == unset, write at end of run).
 * ========================================================================= */
 
SWMM_ENGINE_API int
swmm_files_get(SWMM_Engine engine, const char* key, char* buf, int buflen);
 
SWMM_ENGINE_API int
swmm_files_set(SWMM_Engine engine, const char* key, const char* value);
 
/* =========================================================================
 * Title / notes access
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_title_get_count(SWMM_Engine engine, int* count);
 
SWMM_ENGINE_API int swmm_title_get_line(
    SWMM_Engine engine,
    int         index,
    char*       buf,
    int         buflen
);
 
SWMM_ENGINE_API int swmm_title_add_line(SWMM_Engine engine, const char* line);
 
SWMM_ENGINE_API int swmm_title_set(SWMM_Engine engine, const char* text);
 
SWMM_ENGINE_API int swmm_title_clear(SWMM_Engine engine);
 
/* =========================================================================
 * OPTIONS access
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_options_get(
    SWMM_Engine engine,
    const char* key,
    char*       buf,
    int         buflen
);
 
SWMM_ENGINE_API int swmm_options_set(
    SWMM_Engine engine,
    const char* key,
    const char* value
);
 
SWMM_ENGINE_API int swmm_options_get_ext(
    SWMM_Engine engine,
    const char* key,
    char*       buf,
    int         buflen
);
 
SWMM_ENGINE_API int swmm_options_set_ext(
    SWMM_Engine engine,
    const char* key,
    const char* value
);
 
SWMM_ENGINE_API int swmm_get_crs(SWMM_Engine engine, char* buf, int buflen);
 
/* =========================================================================
 * Typed time-control accessors
 *
 * Date values are SWMM OADate doubles: the integer part is days since
 * 1899-12-30 and the fractional part is the time-of-day fraction.
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_options_get_start_date(SWMM_Engine engine, double* value);
 
SWMM_ENGINE_API int swmm_options_set_start_date(SWMM_Engine engine, double value);
 
SWMM_ENGINE_API int swmm_options_get_end_date(SWMM_Engine engine, double* value);
 
SWMM_ENGINE_API int swmm_options_set_end_date(SWMM_Engine engine, double value);
 
SWMM_ENGINE_API int swmm_options_get_report_start(SWMM_Engine engine, double* value);
 
SWMM_ENGINE_API int swmm_options_set_report_start(SWMM_Engine engine, double value);
 
/* =========================================================================
 * User flags
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_userflag_get_bool(SWMM_Engine engine, const char* name, int*    value);
 
SWMM_ENGINE_API int swmm_userflag_get_int (SWMM_Engine engine, const char* name, int*    value);
 
SWMM_ENGINE_API int swmm_userflag_get_real(SWMM_Engine engine, const char* name, double* value);
 
SWMM_ENGINE_API int swmm_userflag_set_bool(SWMM_Engine engine, const char* name, int    value);
 
SWMM_ENGINE_API int swmm_userflag_set_int (SWMM_Engine engine, const char* name, int    value);
 
SWMM_ENGINE_API int swmm_userflag_set_real(SWMM_Engine engine, const char* name, double value);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_MODEL_H */