openswmmvis::project::examples::ExampleInfo Struct Reference

#include <examplesseeder.h>

Collaboration diagram for openswmmvis::project::examples::ExampleInfo:

Public Attributes
QString	displayName
	From example.json "name", else prettified file/dir name.
QString	description
	From example.json "description"; may be empty.
QString	category
QString	openPath
	Absolute path of the .oswp (preferred) or .inp inside sourceRoot.
QString	sourceRoot
	Directory to copy (dir example) or the single .inp file (flat example).
bool	isDirectory = false
	Directory-per-example vs legacy flat .inp.

Detailed Description

One entry for the Welcome screen's Example Projects panel.

Member Data Documentation

category

QString openswmmvis::project::examples::ExampleInfo::category

From example.json "category"; empty = the Welcome panel's default group (it owns that group's label, which needs tr() — this header stays widget-free).

description

QString openswmmvis::project::examples::ExampleInfo::description

From example.json "description"; may be empty.

displayName

QString openswmmvis::project::examples::ExampleInfo::displayName

From example.json "name", else prettified file/dir name.

isDirectory

bool openswmmvis::project::examples::ExampleInfo::isDirectory = false

Directory-per-example vs legacy flat .inp.

openPath

QString openswmmvis::project::examples::ExampleInfo::openPath

Absolute path of the .oswp (preferred) or .inp inside sourceRoot.

sourceRoot

QString openswmmvis::project::examples::ExampleInfo::sourceRoot

Directory to copy (dir example) or the single .inp file (flat example).

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/project/examplesseeder.h