openswmmvis::ui::InletEditorDialog Class Reference

#include <inleteditordialog.h>

Inheritance diagram for openswmmvis::ui::InletEditorDialog:

Collaboration diagram for openswmmvis::ui::InletEditorDialog:

Public Types
enum class	Mode {   Edit ,   CreateNew }

Public Member Functions
	InletEditorDialog (openswmmvis::inlet::InletRegistry *registry, SWMMModelLayer *layer, QUndoStack *undoStack, QWidget *parent=nullptr)
	~InletEditorDialog () override
void	openForInlet (const QString &name)
	Show (raising an already-open instance) and select name.
Mode	mode () const noexcept
openswmmvis::inlet::InletProvider *	currentProvider () const noexcept
QListView *	listView () const noexcept
InletListModel *	listModel () const noexcept
QLineEdit *	nameEdit () const noexcept
QComboBox *	typeCombo () const noexcept
QTreeView *	propertyTree () const noexcept
InletDrawingView *	drawingView () const noexcept
void	invokeNew ()
void	deleteCurrentSilently ()

Static Public Member Functions
static InletEditorDialog *	createNew (openswmmvis::inlet::InletRegistry *registry, SWMMModelLayer *layer, QUndoStack *undoStack, QWidget *parent=nullptr)
static QString	pickInlet (openswmmvis::inlet::InletRegistry *registry, SWMMModelLayer *layer, QUndoStack *undoStack, QWidget *parent, int compatibleXsectShape=-1)
	Modal pick / create / edit entry point for the inlet-usage pickers. compatibleXsectShape is a SWMM_XSectShape id used to filter the list to the designs legal on that host cross-section (STREET → the gutter types, RECT_OPEN / TRAPEZOIDAL → the drop types, CUSTOM everywhere); pass -1 for "any". Returns the name of the design selected on close, or empty. Flushes the registry to the engine afterwards, as pickTransect does.

Member Enumeration Documentation

Mode

enum class openswmmvis::ui::InletEditorDialog::Mode

strong

Enumerator
Edit
CreateNew

Constructor & Destructor Documentation

InletEditorDialog()

openswmmvis::ui::InletEditorDialog::InletEditorDialog	(	openswmmvis::inlet::InletRegistry *	registry,
		SWMMModelLayer *	layer,
		QUndoStack *	undoStack,
		QWidget *	parent = nullptr
	)

Here is the call graph for this function:

~InletEditorDialog()

openswmmvis::ui::InletEditorDialog::~InletEditorDialog ( )

overridedefault

Member Function Documentation

createNew()

InletEditorDialog * openswmmvis::ui::InletEditorDialog::createNew ( openswmmvis::inlet::InletRegistry *  registry, SWMMModelLayer *  layer, QUndoStack *  undoStack, QWidget *  parent = nullptr  )

static

currentProvider()

InletProvider * openswmmvis::ui::InletEditorDialog::currentProvider ( ) const

noexcept

Here is the caller graph for this function:

deleteCurrentSilently()

void openswmmvis::ui::InletEditorDialog::deleteCurrentSilently

(

)

drawingView()

InletDrawingView * openswmmvis::ui::InletEditorDialog::drawingView ( ) const

inlinenoexcept

invokeNew()

void openswmmvis::ui::InletEditorDialog::invokeNew

(

)

listModel()

InletListModel * openswmmvis::ui::InletEditorDialog::listModel ( ) const

inlinenoexcept

listView()

QListView * openswmmvis::ui::InletEditorDialog::listView ( ) const

inlinenoexcept

mode()

Mode openswmmvis::ui::InletEditorDialog::mode ( ) const

inlinenoexcept

nameEdit()

QLineEdit * openswmmvis::ui::InletEditorDialog::nameEdit ( ) const

inlinenoexcept

openForInlet()

void openswmmvis::ui::InletEditorDialog::openForInlet

(

const QString &

name

)

Show (raising an already-open instance) and select name.

pickInlet()

QString openswmmvis::ui::InletEditorDialog::pickInlet ( openswmmvis::inlet::InletRegistry *  registry, SWMMModelLayer *  layer, QUndoStack *  undoStack, QWidget *  parent, int  compatibleXsectShape = -1  )

static

Modal pick / create / edit entry point for the inlet-usage pickers. compatibleXsectShape is a SWMM_XSectShape id used to filter the list to the designs legal on that host cross-section (STREET → the gutter types, RECT_OPEN / TRAPEZOIDAL → the drop types, CUSTOM everywhere); pass -1 for "any". Returns the name of the design selected on close, or empty. Flushes the registry to the engine afterwards, as pickTransect does.

Here is the call graph for this function:

propertyTree()

QTreeView * openswmmvis::ui::InletEditorDialog::propertyTree ( ) const

inlinenoexcept

typeCombo()

QComboBox * openswmmvis::ui::InletEditorDialog::typeCombo ( ) const

inlinenoexcept

---

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

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