OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmm::io::OwnedCheckpointFile Struct Reference

#include <CheckpointFile.hpp>

Collaboration diagram for openswmm::io::OwnedCheckpointFile:

Public Member Functions

 ~OwnedCheckpointFile ()
 Remove file.path when this owner has not called retain().
 
void retain () noexcept
 Release automatic removal responsibility for the companion file.
 

Public Attributes

CheckpointFile file
 
bool owned = true
 

Constructor & Destructor Documentation

◆ ~OwnedCheckpointFile()

openswmm::io::OwnedCheckpointFile::~OwnedCheckpointFile ( )

Remove file.path when this owner has not called retain().

Note
Uses error_code cleanup and ignores removal failures. No other pathname is removed and the companion contract itself owns no open handle.

Member Function Documentation

◆ retain()

void openswmm::io::OwnedCheckpointFile::retain ( )
inlinenoexcept

Release automatic removal responsibility for the companion file.

Postcondition
Destruction leaves file.path on disk. Caller takes responsibility for publication or later cleanup; the file is not moved or opened.

Member Data Documentation

◆ file

CheckpointFile openswmm::io::OwnedCheckpointFile::file

◆ owned

bool openswmm::io::OwnedCheckpointFile::owned = true

The documentation for this struct was generated from the following files: