openswmmvis::inlet Namespace Reference

Classes
class	AddInletCommand
	Create a new design with default parameters. More...
class	DeleteInletCommand
	Delete a design. Undo recreates it from the stored snapshot. More...
struct	InletDesignData
	Every parameter of one inlet design, mirroring SWMM_InletDesign. Snapshot type for the undo commands and the engine round-trip. More...
class	InletProvider
class	InletRegistry
class	RenameInletCommand
	Rename via the registry (uniqueness enforced by the registry). More...
class	SetInletCommentsCommand
	Free-form description ([INLETS] comment line). More...
class	SetInletParamsCommand
	Whole-design snapshot write. The dialog captures the design before the property bag pushes its edit and passes both halves here, so one undo entry covers a multi-field group write. More...
class	SetInletTypeCommand
	Switch the inlet type (which groups of parameters apply). More...

Enumerations
enum class	InletType {   Grate = 0 ,   Curb = 1 ,   Combo = 2 ,   Slotted = 3 ,   DropGrate = 4 ,   DropCurb = 5 ,   Custom = 6 }
	Inlet design type. Values match SWMM_InletType. More...
enum class	GrateType {   PBar50 = 0 ,   PBar50x100 = 1 ,   PBar30 = 2 ,   CurvedVane = 3 ,   TiltBar45 = 4 ,   TiltBar30 = 5 ,   Reticuline = 6 ,   Generic = 7 }
	Grate bar pattern (HEC-22). Values match SWMM_GrateType. More...
enum class	ThroatType {   Horizontal = 0 ,   Inclined = 1 ,   Vertical = 2 }
	Curb-opening throat orientation. Values match SWMM_ThroatType. More...
enum class	InletCurveKind {   None = 0 ,   Diversion = 1 ,   Rating = 2 }
	Custom-inlet capture-curve flavour. Values match SWMM_InletCurveKind. More...

Functions
bool	operator== (const InletDesignData &a, const InletDesignData &b)
	Field-by-field equality — used by setDesign to suppress no-op notifications and by the undo commands to skip empty pushes.
bool	operator!= (const InletDesignData &a, const InletDesignData &b)
QString	inletTypeLabel (InletType t)
	Legacy editor label for a type ("GRATE", "CURB OPENING", "COMBINATION", "SLOTTED DRAIN", "DROP GRATE", "DROP CURB", "CUSTOM"). These are the strings the type combo shows (Uinlet.pas:31-44).
const char *	inletTypeKeyword (InletType t)
	[INLETS] type keyword handed to swmm_inlet_add. A COMBINATION design is created as a GRATE and then promoted by swmm_inlet_set_design, which is the authority on the stored type.
QString	grateTypeLabel (GrateType t)
	HEC-22 grate name ("P_BAR-50", "CURVED_VANE", "GENERIC", …).

Enumeration Type Documentation

GrateType

enum class openswmmvis::inlet::GrateType

strong

Grate bar pattern (HEC-22). Values match SWMM_GrateType.

Enumerator
PBar50
PBar50x100
PBar30
CurvedVane
TiltBar45
TiltBar30
Reticuline
Generic

InletCurveKind

enum class openswmmvis::inlet::InletCurveKind

strong

Custom-inlet capture-curve flavour. Values match SWMM_InletCurveKind.

Enumerator
None
Diversion	captured flow vs approach flow
Rating	captured flow vs water depth

InletType

enum class openswmmvis::inlet::InletType

strong

Inlet design type. Values match SWMM_InletType.

Enumerator
Grate
Curb
Combo
Slotted
DropGrate
DropCurb
Custom

ThroatType

enum class openswmmvis::inlet::ThroatType

strong

Curb-opening throat orientation. Values match SWMM_ThroatType.

Enumerator
Horizontal
Inclined
Vertical

Function Documentation

grateTypeLabel()

QString openswmmvis::inlet::grateTypeLabel

(

GrateType

t

)

HEC-22 grate name ("P_BAR-50", "CURVED_VANE", "GENERIC", …).

inletTypeKeyword()

const char * openswmmvis::inlet::inletTypeKeyword

(

InletType

t

)

[INLETS] type keyword handed to swmm_inlet_add. A COMBINATION design is created as a GRATE and then promoted by swmm_inlet_set_design, which is the authority on the stored type.

Here is the caller graph for this function:

inletTypeLabel()

QString openswmmvis::inlet::inletTypeLabel

(

InletType

t

)

Legacy editor label for a type ("GRATE", "CURB OPENING", "COMBINATION", "SLOTTED DRAIN", "DROP GRATE", "DROP CURB", "CUSTOM"). These are the strings the type combo shows (Uinlet.pas:31-44).

Here is the caller graph for this function:

operator!=()

bool openswmmvis::inlet::operator!= ( const InletDesignData &  a, const InletDesignData &  b  )

inline

operator==()

bool openswmmvis::inlet::operator==	(	const InletDesignData &	a,
		const InletDesignData &	b
	)

Field-by-field equality — used by setDesign to suppress no-op notifications and by the undo commands to skip empty pushes.