openswmmvis::io::ExportField Struct Reference

One attribute column of an ExportTable. More...

#include <vectorexport.h>

Collaboration diagram for openswmmvis::io::ExportField:

Public Member Functions
QString	description () const
	Format the column description for GIS metadata.

Public Attributes
QString	name
	Output name: an import key or a sanitised label (§8.4, Q9).
QString	label
	Full readable label, e.g. "Max Depth".
QString	unit
	e.g. "ft"; empty when unitless.
openswmmvis::feature::FieldType	type = openswmmvis::feature::FieldType::Text
QVector< openswmmvis::feature::FieldChoice >	choices

Detailed Description

One attribute column of an ExportTable.

Member Function Documentation

description()

QString openswmmvis::io::ExportField::description ( ) const

inline

Format the column description for GIS metadata.

"Label (unit)" — the description written with the column.

Returns

label alone for empty unit, otherwise label followed by the parenthesized unit; no conversion occurs.

Member Data Documentation

choices

QVector<openswmmvis::feature::FieldChoice> openswmmvis::io::ExportField::choices

Stable tokens a Choice column holds; written as a value list where the format keeps one.

label

QString openswmmvis::io::ExportField::label

Full readable label, e.g. "Max Depth".

name

QString openswmmvis::io::ExportField::name

Output name: an import key or a sanitised label (§8.4, Q9).

type

openswmmvis::feature::FieldType openswmmvis::io::ExportField::type = openswmmvis::feature::FieldType::Text

unit

QString openswmmvis::io::ExportField::unit

e.g. "ft"; empty when unitless.

---

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

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