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

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::FilesSpec:

Public Member Functions

bool has_any () const noexcept
 Test whether an interface-file operation is configured.
 

Public Attributes

FileMode rainfall_mode = FileMode::NONE
 
FilePathPair rainfall_path
 
FileMode runoff_mode = FileMode::NONE
 
FilePathPair runoff_path
 
FileMode rdii_mode = FileMode::NONE
 
FilePathPair rdii_path
 
FilePathPair inflows_path
 Legacy semantics: USE only.
 
FilePathPair outflows_path
 Legacy semantics: SAVE only.
 
FilePathPair hotstart_use_path
 Legacy semantics: USE — single hot-start input file.
 
std::vector< HotstartSaveEntry > hotstart_saves
 

Member Function Documentation

◆ has_any()

bool openswmm::FilesSpec::has_any ( ) const
inlinenodiscardnoexcept

Test whether an interface-file operation is configured.

Does not access the filesystem. Mode flags count even with empty paths; FilePathPair emptiness refers to the authored token, not its resolved cache.

Returns
True if any rainfall/runoff/RDII mode is enabled or an inflow/outflow/hotstart path or save schedule is present.
Here is the caller graph for this function:

Member Data Documentation

◆ hotstart_saves

std::vector<HotstartSaveEntry> openswmm::FilesSpec::hotstart_saves

Legacy semantics: SAVE — one or more hot-start output files, each with an optional datetime (SWMM decimal day, 0 = end of run). Legacy supported up to 10; we don't enforce that here.

◆ hotstart_use_path

FilePathPair openswmm::FilesSpec::hotstart_use_path

Legacy semantics: USE — single hot-start input file.

◆ inflows_path

FilePathPair openswmm::FilesSpec::inflows_path

Legacy semantics: USE only.

◆ outflows_path

FilePathPair openswmm::FilesSpec::outflows_path

Legacy semantics: SAVE only.

◆ rainfall_mode

FileMode openswmm::FilesSpec::rainfall_mode = FileMode::NONE

◆ rainfall_path

FilePathPair openswmm::FilesSpec::rainfall_path

◆ rdii_mode

FileMode openswmm::FilesSpec::rdii_mode = FileMode::NONE

◆ rdii_path

FilePathPair openswmm::FilesSpec::rdii_path

◆ runoff_mode

FileMode openswmm::FilesSpec::runoff_mode = FileMode::NONE

◆ runoff_path

FilePathPair openswmm::FilesSpec::runoff_path

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