openswmm_controls.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_CONTROLS_H
#define OPENSWMM_CONTROLS_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Control rules
 * ========================================================================= */

SWMM_ENGINE_API int swmm_control_add_rule(SWMM_Engine engine, const char* rule_text);

SWMM_ENGINE_API int swmm_control_count(SWMM_Engine engine);

SWMM_ENGINE_API int swmm_control_get_rule(SWMM_Engine engine, int idx, char* buf, int buflen);

SWMM_ENGINE_API int swmm_control_get_id(SWMM_Engine engine, int idx, char* buf, int buflen);

SWMM_ENGINE_API int swmm_control_clear_rules(SWMM_Engine engine);

SWMM_ENGINE_API int swmm_control_remove_rule(SWMM_Engine engine, int idx);

SWMM_ENGINE_API int swmm_control_find_references(SWMM_Engine engine,
                                                 const char* object_name,
                                                 int* rule_indices_out,
                                                 int* n_inout);

SWMM_ENGINE_API int swmm_control_validate_rule(SWMM_Engine engine,
                                                const char* rule_text,
                                                char* errbuf, int buflen,
                                                int* line_out);
 
/* =========================================================================
 * Direct control actions (without rules)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_control_set_link_setting(SWMM_Engine engine, int link_idx, double setting);

SWMM_ENGINE_API int swmm_control_set_link_status(SWMM_Engine engine, int link_idx, int status);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_CONTROLS_H */