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::SeriesSpec Struct Reference

One chart series — points at a RunSource via index and identifies what to read from it. More...

#include <comparisonplotmodel.h>

Collaboration diagram for openswmmvis::plot::SeriesSpec:

Public Member Functions

ResultDescriptor descriptor () const
 
bool isValid () const noexcept
 

Public Attributes

int runIndex = -1
 
ObjectRef objectRef
 
PlotAttribute attribute = PlotAttribute::Unknown
 
QString species
 
SeriesStyle style
 
QString legendOverride
 Empty = auto-generate from (run, ref, attr).
 

Detailed Description

One chart series — points at a RunSource via index and identifies what to read from it.

Member Function Documentation

◆ descriptor()

ResultDescriptor openswmmvis::plot::SeriesSpec::descriptor ( ) const
inline

What this series plots, as the descriptor the resolution and row-keying paths consume.

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

◆ isValid()

bool openswmmvis::plot::SeriesSpec::isValid ( ) const
inlinenoexcept
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ attribute

PlotAttribute openswmmvis::plot::SeriesSpec::attribute = PlotAttribute::Unknown

◆ legendOverride

QString openswmmvis::plot::SeriesSpec::legendOverride

Empty = auto-generate from (run, ref, attr).

◆ objectRef

ObjectRef openswmmvis::plot::SeriesSpec::objectRef

◆ runIndex

int openswmmvis::plot::SeriesSpec::runIndex = -1

◆ species

QString openswmmvis::plot::SeriesSpec::species

Y2b-2 (amendment D-Y4): species NAME when this series plots a water-quality species; empty for a fixed attribute. The name is the identity (D-G1) — resolution to the run's column index happens at fetch time, never here. attribute stays Unknown for a species series.

◆ style

SeriesStyle openswmmvis::plot::SeriesSpec::style

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