openswmmvis::plot::ResultDescriptor Struct Reference

One plottable result: a fixed attribute OR a species by name. More...

#include <resultdescriptor.h>

Collaboration diagram for openswmmvis::plot::ResultDescriptor:

Public Member Functions
bool	isSpecies () const noexcept
bool	isValid () const noexcept
QString	label () const
	Picker label: labelFor(attr) for a fixed attribute; the species display label (friendly text for the reserved pair, the bare name otherwise) for a species.
QString	unitLabel (UnitSystem u, const QString &concentrationUnit=QStringLiteral("mg/L")) const
	Unit string. Fixed attributes use unitsFor(attr, u); species use the reserved pair's fixed units (h / °C) or concentrationUnit for an ordinary pollutant.
bool	operator== (const ResultDescriptor &o) const noexcept
bool	operator!= (const ResultDescriptor &o) const noexcept

Static Public Member Functions
static ResultDescriptor	forAttribute (PlotAttribute a)
static ResultDescriptor	forSpecies (const QString &name)

Public Attributes
PlotAttribute	attr = PlotAttribute::Unknown
QString	species

Detailed Description

One plottable result: a fixed attribute OR a species by name.

Member Function Documentation

forAttribute()

static ResultDescriptor openswmmvis::plot::ResultDescriptor::forAttribute ( PlotAttribute  a )

inlinestatic

Here is the caller graph for this function:

forSpecies()

static ResultDescriptor openswmmvis::plot::ResultDescriptor::forSpecies ( const QString &  name )

inlinestatic

Here is the caller graph for this function:

isSpecies()

bool openswmmvis::plot::ResultDescriptor::isSpecies ( ) const

inlinenoexcept

Here is the caller graph for this function:

isValid()

bool openswmmvis::plot::ResultDescriptor::isValid ( ) const

inlinenoexcept

Here is the caller graph for this function:

label()

QString openswmmvis::plot::ResultDescriptor::label

(

)

const

Picker label: labelFor(attr) for a fixed attribute; the species display label (friendly text for the reserved pair, the bare name otherwise) for a species.

Here is the call graph for this function:

operator!=()

bool openswmmvis::plot::ResultDescriptor::operator!= ( const ResultDescriptor &  o ) const

inlinenoexcept

operator==()

bool openswmmvis::plot::ResultDescriptor::operator== ( const ResultDescriptor &  o ) const

inlinenoexcept

unitLabel()

QString openswmmvis::plot::ResultDescriptor::unitLabel	(	UnitSystem	u,
		const QString &	concentrationUnit = QStringLiteral("mg/L")
	)		const

Unit string. Fixed attributes use unitsFor(attr, u); species use the reserved pair's fixed units (h / °C) or concentrationUnit for an ordinary pollutant.

Here is the call graph for this function:

Member Data Documentation

attr

PlotAttribute openswmmvis::plot::ResultDescriptor::attr = PlotAttribute::Unknown

Fixed attribute; Unknown when this descriptor is a species.

species

QString openswmmvis::plot::ResultDescriptor::species

Species name (TSS, __WATER_AGE__, …) when attr == Unknown; empty for a fixed attribute. The NAME is the identity (D-G1).

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/plot/resultdescriptor.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/plot/resultdescriptor.cpp