Describes one editable per-cell parameter: how to label it, how to configure a numeric editor for it, and whether it is live yet. More...

#include <meshcellparams.h>

Collaboration diagram for mesh::CellParamSpec:

Public Types
enum class	Kind { Double , Enum }

Public Attributes
QByteArray	key
	stable id, e.g. "mannings", "initDepth"

QString	label
	combo / property label, already translated

QString	prefix
	spin-box prefix, e.g. "n=" ({} for none)

bool	lengthUnit = false
	true → append the project depth unit

double	min = 0.0

double	max = 1.0

double	step = 0.01

double	defaultValue = 0.0

int	decimals = 4

bool	enabled = true
	false → engine support pending

QString	tooltip

Kind	kind = Kind::Double

QStringList	enumLabels

Detailed Description

Describes one editable per-cell parameter: how to label it, how to configure a numeric editor for it, and whether it is live yet.

Member Enumeration Documentation

◆ Kind

enum class mesh::CellParamSpec::Kind

strong

What kind of value the parameter carries. GUI plan §3.5(1): the infiltration METHOD is an enumeration, not a magic double, so every surface fed by this registry (attribute table, mesh-editing toolbar, property adapter, assign dialog) can pick a combo editor for it from one place.

Enumerator
Double
Enum

Member Data Documentation

◆ decimals

int mesh::CellParamSpec::decimals = 4

◆ defaultValue

double mesh::CellParamSpec::defaultValue = 0.0

◆ enabled

bool mesh::CellParamSpec::enabled = true

false → engine support pending

◆ enumLabels

QStringList mesh::CellParamSpec::enumLabels

Choice labels for Kind::Enum, in the enumeration's own order. The stored value is the enum's integer, not the label index — the labels are display-only. Empty for Kind::Double.

◆ key

QByteArray mesh::CellParamSpec::key

stable id, e.g. "mannings", "initDepth"

◆ kind

Kind mesh::CellParamSpec::kind = Kind::Double

Value kind. New members stay at the END of the struct: the registry builds its entries with positional aggregate initialisers, which fall back to these default member initialisers for anything they omit.

◆ label

QString mesh::CellParamSpec::label

combo / property label, already translated

◆ lengthUnit

bool mesh::CellParamSpec::lengthUnit = false

true → append the project depth unit

◆ max

double mesh::CellParamSpec::max = 1.0

◆ min

double mesh::CellParamSpec::min = 0.0

◆ prefix

QString mesh::CellParamSpec::prefix

spin-box prefix, e.g. "n=" ({} for none)

◆ step

double mesh::CellParamSpec::step = 0.01

◆ tooltip

QString mesh::CellParamSpec::tooltip

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

/home/runner/work/openswmm.gui/openswmm.gui/include/mesh/meshcellparams.h

Public Types

Public Attributes