IEngineLease.hpp File Reference

RAII read/write access to the GUI-owned engine image. More...

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

Go to the source code of this file.

Classes
class	OpenSWMM::Sdk::IEngineLease

Namespaces
namespace	OpenSWMM
namespace	OpenSWMM::Sdk
	Public header-only ABI for independently compiled native GUI extensions.

Enumerations
enum class	OpenSWMM::Sdk::LeaseKind {   OpenSWMM::Sdk::Read ,   OpenSWMM::Sdk::Write }
	Requested access to a GUI-owned model engine. More...

Detailed Description

RAII read/write access to the GUI-owned engine image.

Read leases can coexist. A write lease excludes all other leases and simulation runs. A handle must never be closed or destroyed by an extension and must not escape its lease.

Author

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

Date

2026

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

GPL-3.0-or-later