SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::plot::RainfallSeriesModel Class Reference

#include <rainfallseriesmodel.h>

Inheritance diagram for openswmmvis::plot::RainfallSeriesModel:
Collaboration diagram for openswmmvis::plot::RainfallSeriesModel:

Public Types

enum class  Basis {
  Intensity ,
  DepthPerInterval ,
  CumulativeDepth
}
 Display basis for chart series built from a gage. More...
 

Signals

void reloaded ()
 reload() finished; consumers rebuild charts/tables.
 

Public Member Functions

 RainfallSeriesModel (QObject *parent=nullptr)
 
void setEngine (void *engineHandle)
 Bind the engine handle (void* keeps the header MOC-clean; registry precedent). Does not load — call reload().
 
void * engine () const noexcept
 
int reload (bool reloadRainFiles)
 Re-assemble every gage's series from the engine.
 
const QVector< RainGageRainfall > & gages () const noexcept
 

Static Public Member Functions

static RainGageStats computeStats (const RainGageRainfall &g)
 
static QVector< QPointF > buildStepSeries (const RainGageRainfall &g, Basis b)
 Step-function chart points for the engine's application contract: per entry (t_i, v_i) (t_end, v_i) with t_end = min(t_i + interval, t_{i+1}), plus explicit zero segments across gaps. X is msecsSinceEpoch (QDateTimeAxis convention).
 
static QVector< QPointF > buildCumulativeSeries (const RainGageRainfall &g)
 Cumulative-depth polyline (X msecsSinceEpoch, Y total depth).
 
static double entryDurationSecs (const RainGageRainfall &g, int i)
 Effective accrual duration of entry i in seconds: min(recording interval, spacing to the next entry).
 

Member Enumeration Documentation

◆ Basis

Display basis for chart series built from a gage.

Enumerator
Intensity 

As resolved: units/hr, step function.

DepthPerInterval 

Depth accrued over each entry's interval.

CumulativeDepth 

Running total depth.

Constructor & Destructor Documentation

◆ RainfallSeriesModel()

openswmmvis::plot::RainfallSeriesModel::RainfallSeriesModel ( QObject *  parent = nullptr)
explicit

Member Function Documentation

◆ buildCumulativeSeries()

QVector< QPointF > openswmmvis::plot::RainfallSeriesModel::buildCumulativeSeries ( const RainGageRainfall g)
static

Cumulative-depth polyline (X msecsSinceEpoch, Y total depth).

Here is the call graph for this function:

◆ buildStepSeries()

QVector< QPointF > openswmmvis::plot::RainfallSeriesModel::buildStepSeries ( const RainGageRainfall g,
Basis  b 
)
static

Step-function chart points for the engine's application contract: per entry (t_i, v_i) (t_end, v_i) with t_end = min(t_i + interval, t_{i+1}), plus explicit zero segments across gaps. X is msecsSinceEpoch (QDateTimeAxis convention).

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeStats()

RainGageStats openswmmvis::plot::RainfallSeriesModel::computeStats ( const RainGageRainfall g)
static
Here is the call graph for this function:

◆ engine()

void * openswmmvis::plot::RainfallSeriesModel::engine ( ) const
inlinenoexcept

◆ entryDurationSecs()

double openswmmvis::plot::RainfallSeriesModel::entryDurationSecs ( const RainGageRainfall g,
int  i 
)
static

Effective accrual duration of entry i in seconds: min(recording interval, spacing to the next entry).

Here is the caller graph for this function:

◆ gages()

const QVector< RainGageRainfall > & openswmmvis::plot::RainfallSeriesModel::gages ( ) const
inlinenoexcept
Here is the caller graph for this function:

◆ reload()

int openswmmvis::plot::RainfallSeriesModel::reload ( bool  reloadRainFiles)

Re-assemble every gage's series from the engine.

Parameters
reloadRainFilesAlso re-read FILE-gage data from disk first (skipped silently unless the engine is in an editable state).
Returns
Number of gages assembled (0 when no engine is bound).
Here is the call graph for this function:
Here is the caller graph for this function:

◆ reloaded

void openswmmvis::plot::RainfallSeriesModel::reloaded ( )
signal

reload() finished; consumers rebuild charts/tables.

Here is the caller graph for this function:

◆ setEngine()

void openswmmvis::plot::RainfallSeriesModel::setEngine ( void *  engineHandle)
inline

Bind the engine handle (void* keeps the header MOC-clean; registry precedent). Does not load — call reload().

Here is the caller graph for this function:

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