openswmm_tables.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_TABLES_H
#define OPENSWMM_TABLES_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Identity
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_table_count(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_table_index(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API const char* swmm_table_id(SWMM_Engine engine, int idx);
 
SWMM_ENGINE_API int swmm_table_get_type(SWMM_Engine engine, int idx, int* type);
 
/* =========================================================================
 * Creation (BUILDING state only)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_timeseries_add(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API int swmm_curve_add(SWMM_Engine engine, const char* id, int type);
 
/* =========================================================================
 * Data points
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_table_add_point(SWMM_Engine engine, int idx, double x, double y);
 
SWMM_ENGINE_API int swmm_table_get_point_count(SWMM_Engine engine, int idx, int* count);
 
SWMM_ENGINE_API int swmm_table_get_point(SWMM_Engine engine, int idx, int pt_idx, double* x, double* y);
 
SWMM_ENGINE_API int swmm_table_clear(SWMM_Engine engine, int idx);
 
/* =========================================================================
 * Lookup (cursor-optimized)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_table_lookup(SWMM_Engine engine, int idx, double x, double* y);
 
/* =========================================================================
 * Patterns
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_pattern_add(SWMM_Engine engine, const char* id, int type);
 
SWMM_ENGINE_API int swmm_pattern_set_factors(SWMM_Engine engine, int idx, const double* factors, int count);
 
SWMM_ENGINE_API int swmm_pattern_count(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_pattern_index(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API const char* swmm_pattern_id(SWMM_Engine engine, int idx);
 
SWMM_ENGINE_API int swmm_pattern_get_type(SWMM_Engine engine, int idx, int* type);
 
SWMM_ENGINE_API int swmm_pattern_get_factor_count(SWMM_Engine engine, int idx, int* count);
 
SWMM_ENGINE_API int swmm_pattern_get_factor(SWMM_Engine engine, int idx, int i, double* v);
 
SWMM_ENGINE_API int swmm_pattern_remove(SWMM_Engine engine, int idx);
 
SWMM_ENGINE_API int swmm_pattern_rename(SWMM_Engine engine, int idx, const char* newId);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_TABLES_H */