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);
 
/* =========================================================================
 * 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);
 
/* =========================================================================
 * 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 */