openswmm_callbacks.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_ENGINE_CALLBACKS_H
#define OPENSWMM_ENGINE_CALLBACKS_H
 
#ifdef __cplusplus
extern "C" {
#endif

typedef void* SWMM_Engine;
 
/* =========================================================================
 * Progress callback
 * ========================================================================= */

typedef void (*SWMM_ProgressCallback)(SWMM_Engine engine, double elapsed_frac, double sim_time,
                                      void* user_data);

typedef int (*SWMM_CancelCallback)(SWMM_Engine engine, int stage, int progress, void* user_data);
 
/* =========================================================================
 * Warning / error callback
 * ========================================================================= */

typedef void (*SWMM_WarningCallback)(SWMM_Engine engine, int code, const char* message,
                                     void* user_data);
 
/* =========================================================================
 * Timestep begin/end callbacks
 * ========================================================================= */

typedef void (*SWMM_StepBeginCallback)(SWMM_Engine engine, double sim_time, double dt,
                                       void* user_data);

typedef void (*SWMM_StepEndCallback)(SWMM_Engine engine, double sim_time, double dt,
                                     void* user_data);
 
/* =========================================================================
 * Plugin event callbacks (fired by the plugin system)
 * ========================================================================= */

typedef void (*SWMM_PluginStateCallback)(SWMM_Engine engine, const char* plugin_id, int old_state,
                                         int new_state, void* user_data);
 
/* =========================================================================
 * Hot start callbacks
 * ========================================================================= */

typedef void (*SWMM_HotStartMissingCallback)(SWMM_Engine engine, const char* object_type,
                                             const char* object_id, void* user_data);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_ENGINE_CALLBACKS_H */