d2/d9f/openswmm__tables_8h_source.html

#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);


/* =========================================================================

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


#ifdef __cplusplus

} /* extern "C" */

#endif


#endif /* OPENSWMM_TABLES_H */

y
double * y
Definition odesolve.c:28

SWMM_Engine
void * SWMM_Engine
Opaque handle to an OpenSWMM Engine instance.
Definition openswmm_callbacks.h:35

openswmm_engine.h
OpenSWMM Engine — primary transparent C API (master header).

SWMM_ENGINE_API
#define SWMM_ENGINE_API
Definition openswmm_engine.h:87

swmm_table_add_point
SWMM_ENGINE_API int swmm_table_add_point(SWMM_Engine engine, int idx, double x, double y)
Append a data point (x, y) to a table.
Definition openswmm_tables_impl.cpp:85

swmm_pattern_add
SWMM_ENGINE_API int swmm_pattern_add(SWMM_Engine engine, const char *id, int type)
Add a new time pattern to the model.
Definition openswmm_tables_impl.cpp:143

swmm_table_get_point
SWMM_ENGINE_API int swmm_table_get_point(SWMM_Engine engine, int idx, int pt_idx, double *x, double *y)
Get a specific data point from a table.
Definition openswmm_tables_impl.cpp:103

swmm_table_lookup
SWMM_ENGINE_API int swmm_table_lookup(SWMM_Engine engine, int idx, double x, double *y)
Interpolate a Y value from a table for a given X.
Definition openswmm_tables_impl.cpp:130

swmm_table_get_point_count
SWMM_ENGINE_API int swmm_table_get_point_count(SWMM_Engine engine, int idx, int *count)
Get the number of data points in a table.
Definition openswmm_tables_impl.cpp:95

swmm_timeseries_add
SWMM_ENGINE_API int swmm_timeseries_add(SWMM_Engine engine, const char *id)
Add a new time series to the model.
Definition openswmm_tables_impl.cpp:43

swmm_table_clear
SWMM_ENGINE_API int swmm_table_clear(SWMM_Engine engine, int idx)
Remove all data points from a table.
Definition openswmm_tables_impl.cpp:115

swmm_table_count
SWMM_ENGINE_API int swmm_table_count(SWMM_Engine engine)
Get the total number of tables (time series + curves) in the model.
Definition openswmm_tables_impl.cpp:22

swmm_pattern_count
SWMM_ENGINE_API int swmm_pattern_count(SWMM_Engine engine)
Get the total number of time patterns in the model.
Definition openswmm_tables_impl.cpp:164

swmm_table_id
SWMM_ENGINE_API const char * swmm_table_id(SWMM_Engine engine, int idx)
Get the string identifier of a table by index.
Definition openswmm_tables_impl.cpp:32

swmm_curve_add
SWMM_ENGINE_API int swmm_curve_add(SWMM_Engine engine, const char *id, int type)
Add a new curve to the model.
Definition openswmm_tables_impl.cpp:62

swmm_table_index
SWMM_ENGINE_API int swmm_table_index(SWMM_Engine engine, const char *id)
Look up a table's zero-based index by its string identifier.
Definition openswmm_tables_impl.cpp:27

swmm_pattern_set_factors
SWMM_ENGINE_API int swmm_pattern_set_factors(SWMM_Engine engine, int idx, const double *factors, int count)
Set the multiplier factors for a time pattern.
Definition openswmm_tables_impl.cpp:155