OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm_controls.h
Go to the documentation of this file.
1
16#ifndef OPENSWMM_CONTROLS_H
17#define OPENSWMM_CONTROLS_H
18
19#include "openswmm_engine.h"
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/* =========================================================================
26 * Control rules
27 * ========================================================================= */
28
40SWMM_ENGINE_API int swmm_control_add_rule(SWMM_Engine engine, const char* rule_text);
41
47SWMM_ENGINE_API int swmm_control_count(SWMM_Engine engine);
48
57SWMM_ENGINE_API int swmm_control_get_rule(SWMM_Engine engine, int idx, char* buf, int buflen);
58
64SWMM_ENGINE_API int swmm_control_clear_rules(SWMM_Engine engine);
65
66/* =========================================================================
67 * Direct control actions (without rules)
68 * ========================================================================= */
69
81SWMM_ENGINE_API int swmm_control_set_link_setting(SWMM_Engine engine, int link_idx, double setting);
82
93SWMM_ENGINE_API int swmm_control_set_link_status(SWMM_Engine engine, int link_idx, int status);
94
95#ifdef __cplusplus
96} /* extern "C" */
97#endif
98
99#endif /* OPENSWMM_CONTROLS_H */
SWMM_Engine
void * SWMM_Engine
Opaque handle to an OpenSWMM Engine instance.
Definition openswmm_callbacks.h:35
swmm_control_set_link_setting
SWMM_ENGINE_API int swmm_control_set_link_setting(SWMM_Engine engine, int link_idx, double setting)
Directly set the control setting of a link.
Definition openswmm_controls_impl.cpp:62
swmm_control_clear_rules
SWMM_ENGINE_API int swmm_control_clear_rules(SWMM_Engine engine)
Remove all control rules from the model.
Definition openswmm_controls_impl.cpp:51
swmm_control_get_rule
SWMM_ENGINE_API int swmm_control_get_rule(SWMM_Engine engine, int idx, char *buf, int buflen)
Get the text of a control rule by index.
Definition openswmm_controls_impl.cpp:37
swmm_control_add_rule
SWMM_ENGINE_API int swmm_control_add_rule(SWMM_Engine engine, const char *rule_text)
Add a control rule from its text representation.
Definition openswmm_controls_impl.cpp:22
swmm_control_set_link_status
SWMM_ENGINE_API int swmm_control_set_link_status(SWMM_Engine engine, int link_idx, int status)
Directly set the open/close status of a link.
Definition openswmm_controls_impl.cpp:70
swmm_control_count
SWMM_ENGINE_API int swmm_control_count(SWMM_Engine engine)
Get the total number of control rules defined.
Definition openswmm_controls_impl.cpp:32
openswmm_engine.h
OpenSWMM Engine — primary transparent C API (master header).
SWMM_ENGINE_API
#define SWMM_ENGINE_API
Definition openswmm_engine.h:87