openswmmvis::io::Mesh2DResultVariable Struct Reference

#include <mesh2dresultvariable.h>

Collaboration diagram for openswmmvis::io::Mesh2DResultVariable:

Public Types
enum class	Domain {   Surface ,   Groundwater }
enum class	Zone {   None ,   Saturated ,   Unsaturated ,   Sigma }
enum class	Temporal {   Reported ,   Held ,   Static ,   Envelope }

Public Member Functions
QString	key () const
	Encode the source-local dataset, optional species, and optional layer identity.

Public Attributes
QString	dataset
QString	species
QString	label
QString	units
Domain	domain = Domain::Surface
Zone	zone = Zone::None
Temporal	temporal = Temporal::Reported
int	layer = -1
int	frameCount = 0
bool	unitsKnown = false

Member Enumeration Documentation

Domain

enum class openswmmvis::io::Mesh2DResultVariable::Domain

strong

Enumerator
Surface
Groundwater

Temporal

enum class openswmmvis::io::Mesh2DResultVariable::Temporal

strong

Enumerator
Reported
Held
Static
Envelope

Zone

enum class openswmmvis::io::Mesh2DResultVariable::Zone

strong

Enumerator
None
Saturated
Unsaturated
Sigma

Member Function Documentation

key()

QString openswmmvis::io::Mesh2DResultVariable::key ( ) const

inline

Encode the source-local dataset, optional species, and optional layer identity.

Returns

Empty when dataset is empty; otherwise a domain-prefixed key with percent-encoded dataset/species and a nonnegative layer suffix when supplied.

Labels, units, temporal mode, and frame count do not enter the key. The owner must pair this key with its run/source identity.

Here is the caller graph for this function:

Member Data Documentation

dataset

QString openswmmvis::io::Mesh2DResultVariable::dataset

domain

Domain openswmmvis::io::Mesh2DResultVariable::domain = Domain::Surface

frameCount

int openswmmvis::io::Mesh2DResultVariable::frameCount = 0

label

QString openswmmvis::io::Mesh2DResultVariable::label

layer

int openswmmvis::io::Mesh2DResultVariable::layer = -1

species

QString openswmmvis::io::Mesh2DResultVariable::species

temporal

Temporal openswmmvis::io::Mesh2DResultVariable::temporal = Temporal::Reported

units

QString openswmmvis::io::Mesh2DResultVariable::units

unitsKnown

bool openswmmvis::io::Mesh2DResultVariable::unitsKnown = false

zone

Zone openswmmvis::io::Mesh2DResultVariable::zone = Zone::None

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/io/mesh2dresultvariable.h