openswmm_api_common.hpp File Reference

Internal shared helpers for C API impl files. More...

#include "SWMMEngine.hpp"
#include "../../../include/openswmm/engine/openswmm_engine.h"
#include <cstring>
#include <algorithm>

Include dependency graph for openswmm_api_common.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	CHECK_HANDLE(e)   do { if (!(e)) return SWMM_ERR_BADHANDLE; } while(0)
#define	CHECK_INDEX(cond)   do { if (!(cond)) return SWMM_ERR_BADINDEX; } while(0)
#define	CHECK_GEOMETRY(ctx)
	Geometry/topology setters: only BUILDING or OPENED.
#define	CHECK_INITIAL_COND(ctx)
	Initial-condition setters: BUILDING, OPENED, or INITIALIZED.
#define	CHECK_RUNNING(ctx)
	Runtime forcing / state override: only RUNNING.
#define	CHECK_READABLE(ctx)
	Read-only access: any state where data exists (not CREATED, CLOSED, or ERROR)

Detailed Description

Internal shared helpers for C API impl files.

NOT installed — used only by openswmm_*_impl.cpp files. Provides the opaque-handle cast and common guard macros.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 HydroCouple. All rights reserved.

License\n MIT License

Macro Definition Documentation

CHECK_GEOMETRY

#define CHECK_GEOMETRY

(

ctx

)

Value:

    do { \
        if ((ctx).state != openswmm::EngineState::BUILDING && \
            (ctx).state != openswmm::EngineState::OPENED) \
            return SWMM_ERR_LIFECYCLE; \
    } while(0)

Geometry/topology setters: only BUILDING or OPENED.

CHECK_HANDLE

#define CHECK_HANDLE

(

e

)

do { if (!(e)) return SWMM_ERR_BADHANDLE; } while(0)

CHECK_INDEX

#define CHECK_INDEX

(

cond

)

do { if (!(cond)) return SWMM_ERR_BADINDEX; } while(0)

CHECK_INITIAL_COND

#define CHECK_INITIAL_COND

(

ctx

)

Value:

    do { \
        if ((ctx).state != openswmm::EngineState::BUILDING && \
            (ctx).state != openswmm::EngineState::OPENED && \
            (ctx).state != openswmm::EngineState::INITIALIZED) \
            return SWMM_ERR_LIFECYCLE; \
    } while(0)

Initial-condition setters: BUILDING, OPENED, or INITIALIZED.

CHECK_READABLE

#define CHECK_READABLE

(

ctx

)

Value:

    do { \
        if ((ctx).state == openswmm::EngineState::CREATED || \
            (ctx).state == openswmm::EngineState::CLOSED || \
            (ctx).state == openswmm::EngineState::ERROR_STATE) \
            return SWMM_ERR_LIFECYCLE; \
    } while(0)

Read-only access: any state where data exists (not CREATED, CLOSED, or ERROR)

CHECK_RUNNING

#define CHECK_RUNNING

(

ctx

)

Value:

    do { \
        if ((ctx).state != openswmm::EngineState::RUNNING) \
            return SWMM_ERR_LIFECYCLE; \
    } while(0)

Runtime forcing / state override: only RUNNING.