openswmm_initial_quality.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_INITIAL_QUALITY_H
#define OPENSWMM_INITIAL_QUALITY_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif

SWMM_ENGINE_API int swmm_init_quality_count(SWMM_Engine engine);

SWMM_ENGINE_API int swmm_init_quality_get(SWMM_Engine engine, int entry_idx, int* is_link,
                                          int* elem_idx, char* constituent_buf, int constituent_len,
                                          double* value);

SWMM_ENGINE_API int swmm_init_quality_set(SWMM_Engine engine, int is_link, int elem_idx,
                                          const char* constituent, double value);

SWMM_ENGINE_API int swmm_init_quality_remove(SWMM_Engine engine, int entry_idx);
 
/* ---- U2 (2026-09-07): the `[INITIAL_QUALITY] FILE <csv>` sidecar --------
 * Rows read from the sidecar carry is_file = 1 in swmm_init_quality_is_file
 * and are not written back inline; the FILE line is. The CSV format is
 * scope,element,constituent,value per line (comma / whitespace separated,
 * optional header). The file is read at the next open; set/clear here only
 * records the reference.
 */

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

SWMM_ENGINE_API int swmm_init_quality_file_set(SWMM_Engine engine, const char* path);

SWMM_ENGINE_API int swmm_init_quality_is_file(SWMM_Engine engine, int entry_idx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMM_INITIAL_QUALITY_H */