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

A single time series or rating curve. More...

#include <TableData.hpp>

Collaboration diagram for openswmm::Table:

Public Member Functions

std::size_t size () const noexcept
 Number of data points.
 
bool empty () const noexcept
 True if the table has at least one data point.
 

Public Attributes

std::string id
 Table identifier (from input file)
 
TableType type
 Table type (TIMESERIES, CURVE_*, etc.)
 
std::vector< double > x
 Independent variable (time, depth, etc.)
 
std::vector< double > y
 Dependent variable (flow, volume, etc.)
 
TableCursor cursor
 Bidirectional lookup cursor.
 

Detailed Description

A single time series or rating curve.

Stores parallel x and y arrays plus a bidirectional cursor for efficient sequential lookup. The x values must be monotonically non-decreasing.

See also
Legacy reference: TTable in src/solver/objects.h

Member Function Documentation

◆ empty()

bool openswmm::Table::empty ( ) const
inlinenoexcept

True if the table has at least one data point.

◆ size()

std::size_t openswmm::Table::size ( ) const
inlinenoexcept

Number of data points.

Member Data Documentation

◆ cursor

TableCursor openswmm::Table::cursor

Bidirectional lookup cursor.

◆ id

std::string openswmm::Table::id

Table identifier (from input file)

◆ type

TableType openswmm::Table::type

Table type (TIMESERIES, CURVE_*, etc.)

◆ x

std::vector<double> openswmm::Table::x

Independent variable (time, depth, etc.)

◆ y

std::vector<double> openswmm::Table::y

Dependent variable (flow, volume, etc.)


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