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

Hydrograph parameter rows and independent group-to-gage assignments. More...

#include <InflowData.hpp>

Collaboration diagram for openswmm::UnitHydData:

Public Member Functions

int count () const
 Count rows in the primary ordered column.
 
void add_gage (const std::string &uh_name, const std::string &gage)
 Append a copied group-to-gage assignment without deduplication.
 
void add (const UnitHydEntry &e)
 Append a copied authoring row.
 

Public Attributes

std::vector< UnitHydEntry > entries
 
std::vector< std::string > gage_assignments
 Rain gage names associated with each UH group (name → gage name)
 
std::vector< std::string > gage_names
 Assigned rain gage names.
 

Detailed Description

Hydrograph parameter rows and independent group-to-gage assignments.

Owns its strings and vectors; references/iterators into columns may be invalidated by append/erase. Mutating this container does not synchronize engine solver state.

Member Function Documentation

◆ add()

void openswmm::UnitHydData::add ( const UnitHydEntry & e)
inline

Append a copied authoring row.

Low-level authoring storage only: no lifecycle, name/reference, numeric or duplicate validation and no solver-cache rebuild. Caller keeps parallel columns aligned, serializes access and keeps row count representable as int. Allocation exceptions can leave a partially appended row; there is no rollback.

Parameters
[in]eCopied complete parameter row; caller supplies month/response/numeric values in the UnitHydEntry input-unit convention.
Here is the caller graph for this function:

◆ add_gage()

void openswmm::UnitHydData::add_gage ( const std::string & uh_name,
const std::string & gage )
inline

Append a copied group-to-gage assignment without deduplication.

Appends gage_assignments then gage_names; caller maintains alignment and handles partial allocation failure. Does not change parameter entries.

Parameters
[in]uh_nameCopied group name; group/row existence is not checked.
[in]gageCopied rain-gage name; existence is not resolved.
Here is the caller graph for this function:

◆ count()

int openswmm::UnitHydData::count ( ) const
inline

Count rows in the primary ordered column.

Returns
Primary row count converted to int; no alignment verification of the other columns.
Here is the caller graph for this function:

Member Data Documentation

◆ entries

std::vector<UnitHydEntry> openswmm::UnitHydData::entries

◆ gage_assignments

std::vector<std::string> openswmm::UnitHydData::gage_assignments

Rain gage names associated with each UH group (name → gage name)

UH group names

◆ gage_names

std::vector<std::string> openswmm::UnitHydData::gage_names

Assigned rain gage names.


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