openswmmvis::ui::ComparisonPlotDialog Class Reference

#include <comparisonplotdialog.h>

Inheritance diagram for openswmmvis::ui::ComparisonPlotDialog:

Collaboration diagram for openswmmvis::ui::ComparisonPlotDialog:

Signals
void	addFromMapToggled (bool active)
	Slice AT.2 — emitted when the user toggles the "Add from Map…" toolbar action. The dialog itself doesn't know about the canvas; SWMMVis owns the MapToolPlotPick lifecycle.

Public Member Functions
	ComparisonPlotDialog (QWidget *parent=nullptr)
	~ComparisonPlotDialog () override
openswmmvis::plot::ComparisonPlotModel *	model () noexcept
	Underlying model — exposed so callers (Object Browser wiring, CF.3's openComparisonPlotForCells) can add runs/series directly.
int	ensureRunSourceForLayer (::SWMMResultsLayer *layer, bool makeBaseline=false)
	Convenience helper: add a 1D RunSource for the given results layer (or update the existing one if already added) and return its run index.
int	ensureRunSourceForMeshLayer (::SWMM2DResultsLayer *layer)
	CF.3 — add a 2D RunSource for the given mesh results layer (or return the existing one) and return its run index.
int	addSeries (int runIndex, const openswmmvis::plot::ObjectRef &ref, openswmmvis::plot::PlotAttribute attr)
	Convenience helper: add a series in one call. Returns the new series index, or -1 on failure.
int	addSeries (int runIndex, const openswmmvis::plot::ObjectRef &ref, const openswmmvis::plot::ResultDescriptor &descriptor)
	Y2b-2 (amendment D-Y4): descriptor-shaped overload — a fixed attribute or a species BY NAME. The enum overload above forwards here.
int	addCellSeries (int runIndex, const QVector< int > &triIdxList, const QVector< openswmmvis::plot::PlotAttribute > &attributes)
	CF.3 — add per-cell series for the supplied attribute list. Returns the count of series successfully added.
void	setAddFromMapChecked (bool checked)
	Slice AT.2 — programmatically set the Add-from-Map toolbar action's checked state. Used by SWMMVis when the user cancels the pick tool via Escape (so the toolbar button un-toggles).

Constructor & Destructor Documentation

ComparisonPlotDialog()

openswmmvis::ui::ComparisonPlotDialog::ComparisonPlotDialog ( QWidget *  parent = nullptr )

explicit

Here is the call graph for this function:

~ComparisonPlotDialog()

openswmmvis::ui::ComparisonPlotDialog::~ComparisonPlotDialog ( )

overridedefault

Member Function Documentation

addCellSeries()

int openswmmvis::ui::ComparisonPlotDialog::addCellSeries	(	int	runIndex,
		const QVector< int > &	triIdxList,
		const QVector< openswmmvis::plot::PlotAttribute > &	attributes
	)

CF.3 — add per-cell series for the supplied attribute list. Returns the count of series successfully added.

addFromMapToggled

void openswmmvis::ui::ComparisonPlotDialog::addFromMapToggled ( bool  active )

signal

Slice AT.2 — emitted when the user toggles the "Add from Map…" toolbar action. The dialog itself doesn't know about the canvas; SWMMVis owns the MapToolPlotPick lifecycle.

addSeries() [1/2]

int openswmmvis::ui::ComparisonPlotDialog::addSeries	(	int	runIndex,
		const openswmmvis::plot::ObjectRef &	ref,
		const openswmmvis::plot::ResultDescriptor &	descriptor
	)

Y2b-2 (amendment D-Y4): descriptor-shaped overload — a fixed attribute or a species BY NAME. The enum overload above forwards here.

Here is the call graph for this function:

addSeries() [2/2]

int openswmmvis::ui::ComparisonPlotDialog::addSeries	(	int	runIndex,
		const openswmmvis::plot::ObjectRef &	ref,
		openswmmvis::plot::PlotAttribute	attr
	)

Convenience helper: add a series in one call. Returns the new series index, or -1 on failure.

ensureRunSourceForLayer()

int openswmmvis::ui::ComparisonPlotDialog::ensureRunSourceForLayer	(	::SWMMResultsLayer *	layer,
		bool	makeBaseline = false
	)

Convenience helper: add a 1D RunSource for the given results layer (or update the existing one if already added) and return its run index.

Here is the call graph for this function:

ensureRunSourceForMeshLayer()

int openswmmvis::ui::ComparisonPlotDialog::ensureRunSourceForMeshLayer

(

::SWMM2DResultsLayer *

layer

)

CF.3 — add a 2D RunSource for the given mesh results layer (or return the existing one) and return its run index.

Here is the call graph for this function:

model()

openswmmvis::plot::ComparisonPlotModel * openswmmvis::ui::ComparisonPlotDialog::model ( )

inlinenoexcept

Underlying model — exposed so callers (Object Browser wiring, CF.3's openComparisonPlotForCells) can add runs/series directly.

setAddFromMapChecked()

void openswmmvis::ui::ComparisonPlotDialog::setAddFromMapChecked

(

bool

checked

)

Slice AT.2 — programmatically set the Add-from-Map toolbar action's checked state. Used by SWMMVis when the user cancels the pick tool via Escape (so the toolbar button un-toggles).

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/ui/dialogs/comparisonplotdialog.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/ui/dialogs/comparisonplotdialog.cpp