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
OpenSWMM::TimeSeries Namespace Reference

Classes

struct  AssignmentOptions
 Explicit choices collected before preparation; no engine or QObject pointers. More...
 
struct  LocationInfo
 One immutable monitoring location, independent of project feature links. More...
 
struct  Observation
 One source sample with its original metadata and explicit null state. More...
 
struct  ObservationPage
 Owning bounded page; a successful empty page is not an error. More...
 
struct  ObservationQuery
 Keyset/range sample query; all bounds use the series' native time basis. More...
 
struct  PreparedAssignment
 Fully validated copy ready for one checked GUI-thread transaction. More...
 
struct  SeriesInfo
 One homogeneous source series; all identifiers retain leading zeros. More...
 
struct  TimeSeriesDataset
 Immutable collection metadata; reading it does not load observation rows. More...
 
class  TimeSeriesStore
 Source-neutral storage; every call owns/closes GDAL handles on its calling thread. More...
 

Enumerations

enum class  AssignmentTarget {
  SeriesOnly ,
  NodeFlow ,
  OutfallStage ,
  RainGage
}
 Native model input receiving a prepared copy; source data is never modified. More...
 
enum class  TimeBasis {
  Instant ,
  CalendarDate
}
 Time interpretation; dates never implicitly become UTC instants. More...
 

Functions

bool conversion (const QString &source, const QString &target, double &scale, double &offset)
 Resolve a known physical-unit conversion without changing source values.
 
PreparedAssignment prepareAssignment (const TimeSeriesDataset &dataset, const AssignmentOptions &options, std::atomic_bool *cancel=nullptr)
 Read and prepare one explicit contiguous source range on a worker.
 

Enumeration Type Documentation

◆ AssignmentTarget

Native model input receiving a prepared copy; source data is never modified.

Enumerator
SeriesOnly 
NodeFlow 
OutfallStage 
RainGage 

◆ TimeBasis

Time interpretation; dates never implicitly become UTC instants.

Enumerator
Instant 
CalendarDate 

Function Documentation

◆ conversion()

bool OpenSWMM::TimeSeries::conversion ( const QString &  source,
const QString &  target,
double &  scale,
double &  offset 
)

Resolve a known physical-unit conversion without changing source values.

Parameters
[in]sourceNative source unit spelling.
[in]targetRequired target unit spelling.
[out]scaleMultiplier applied before offset on success.
[out]offsetAdditive conversion term (temperature), zero otherwise.
Returns
True for compatible known units or identical nonempty unit text; false otherwise.
Here is the caller graph for this function:

◆ prepareAssignment()

PreparedAssignment OpenSWMM::TimeSeries::prepareAssignment ( const TimeSeriesDataset &  dataset,
const AssignmentOptions &  options,
std::atomic_bool *  cancel = nullptr 
)

Read and prepare one explicit contiguous source range on a worker.

Parameters
[in]datasetImmutable metadata, no handles shared across threads.
[in]optionsUser-reviewed unit/clock/gap/target choices.
[in]cancelOptional cooperative cancellation checked between samples/pages.
Returns
Complete copied values/provenance or a diagnostic; source/model files are never modified.

Missing samples, conflicting times, nonfinite values and post-rounding collisions fail. At most one million prepared points are allowed per operation. Daily holding emits day-start and 23:59:59 values, making the final one-second transition between days explicit in provenance.

Here is the call graph for this function: