d7/de4/_i_engine_lease_8hpp_source.html

#pragma once

namespace OpenSWMM::Sdk

{


enum class LeaseKind {

    Read,

    Write

};


class IEngineLease

{

public:

    virtual ~IEngineLease() = default;

    virtual void *engine() const = 0;

};


}

OpenSWMM::Sdk::IEngineLease
Definition IEngineLease.hpp:20

OpenSWMM::Sdk::IEngineLease::engine
virtual void * engine() const =0
Borrow the current engine while this lease is alive.

OpenSWMM::Sdk::IEngineLease::~IEngineLease
virtual ~IEngineLease()=default
Release the lease on the GUI thread without closing the borrowed engine.

OpenSWMM::Sdk
Public header-only ABI for independently compiled native GUI extensions.
Definition ExtensionHost.hpp:24

OpenSWMM::Sdk::LeaseKind
LeaseKind
Requested access to a GUI-owned model engine.
Definition IEngineLease.hpp:14

OpenSWMM::Sdk::LeaseKind::Write
@ Write
Exclusive native access, excluding all other leases and runs.

OpenSWMM::Sdk::LeaseKind::Read
@ Read
Shared read access, excluding runs and any writer.