openswmm::HotStartFile Struct Reference

In-memory hot start file data. More...

#include <HotStartManager.hpp>

Collaboration diagram for openswmm::HotStartFile:

Public Member Functions
bool	set_node_depth (const std::string &id, double v)
	Set depth for a stored node. Returns false if id not found.
bool	set_node_head (const std::string &id, double v)
	Set head for a stored node. Returns false if id not found.
bool	set_link_flow (const std::string &id, double v)
	Set flow for a stored link. Returns false if id not found.
bool	set_link_depth (const std::string &id, double v)
	Set depth for a stored link. Returns false if id not found.
bool	set_subcatch_runoff (const std::string &id, double v)
	Set runoff for a stored subcatchment. Returns false if id not found.

Public Attributes
HotStartHeader	header
std::vector< HotStartNodeRecord >	nodes
std::vector< HotStartLinkRecord >	links
std::vector< HotStartSubcatchRecord >	subcatches
std::string	path
	File path (for flush-on-close)
bool	dirty = false
	True if set_*() was called.
std::vector< std::string >	warnings
	Populated by HotStartManager::apply()

Detailed Description

In-memory hot start file data.

Created by HotStartManager::save() or HotStartManager::open(). The C API casts HotStartFile* to/from void* SWMM_HotStart.

Member Function Documentation

set_link_depth()

bool openswmm::HotStartFile::set_link_depth	(	const std::string &	id,
		double	v
	)

Set depth for a stored link. Returns false if id not found.

Here is the caller graph for this function:

set_link_flow()

bool openswmm::HotStartFile::set_link_flow	(	const std::string &	id,
		double	v
	)

Set flow for a stored link. Returns false if id not found.

Here is the caller graph for this function:

set_node_depth()

bool openswmm::HotStartFile::set_node_depth	(	const std::string &	id,
		double	v
	)

Set depth for a stored node. Returns false if id not found.

Here is the caller graph for this function:

set_node_head()

bool openswmm::HotStartFile::set_node_head	(	const std::string &	id,
		double	v
	)

Set head for a stored node. Returns false if id not found.

Here is the caller graph for this function:

set_subcatch_runoff()

bool openswmm::HotStartFile::set_subcatch_runoff	(	const std::string &	id,
		double	v
	)

Set runoff for a stored subcatchment. Returns false if id not found.

Here is the caller graph for this function:

Member Data Documentation

dirty

bool openswmm::HotStartFile::dirty = false

True if set_*() was called.

header

HotStartHeader openswmm::HotStartFile::header

links

std::vector<HotStartLinkRecord> openswmm::HotStartFile::links

nodes

std::vector<HotStartNodeRecord> openswmm::HotStartFile::nodes

path

std::string openswmm::HotStartFile::path

File path (for flush-on-close)

subcatches

std::vector<HotStartSubcatchRecord> openswmm::HotStartFile::subcatches

warnings

std::vector<std::string> openswmm::HotStartFile::warnings

Populated by HotStartManager::apply()

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/HotStartManager.hpp
• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/HotStartManager.cpp