SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::inlet::InletProvider Class Reference

#include <inletprovider.h>

Inheritance diagram for openswmmvis::inlet::InletProvider:
Collaboration diagram for openswmmvis::inlet::InletProvider:

Signals

void nameChanged (QString prev, QString now)
 
void paramsChanged ()
 
void commentsChanged ()
 

Public Member Functions

 InletProvider (QString name, QObject *parent=nullptr)
 
 ~InletProvider () override
 
QString name () const noexcept
 
QString comments () const
 
const InletDesignDatadesign () const noexcept
 Whole-design snapshot (undo + engine flush).
 
InletType type () const noexcept
 
double grateLength () const noexcept
 
double grateWidth () const noexcept
 
GrateType grateType () const noexcept
 
double openArea () const noexcept
 
double splashVeloc () const noexcept
 
double curbLength () const noexcept
 
double curbHeight () const noexcept
 
ThroatType throat () const noexcept
 
double slotLength () const noexcept
 
double slotWidth () const noexcept
 
QString curveId () const
 
InletCurveKind curveKind () const noexcept
 
void setName (QString newName)
 
void setComments (QString text)
 
void setDesign (const InletDesignData &d)
 Replace every design field at once. Emits paramsChanged() once if anything actually changed.
 
void setType (InletType v)
 
void setGrateLength (double v)
 
void setGrateWidth (double v)
 
void setGrateType (GrateType v)
 
void setOpenArea (double v)
 
void setSplashVeloc (double v)
 
void setCurbLength (double v)
 
void setCurbHeight (double v)
 
void setThroat (ThroatType v)
 
void setSlotLength (double v)
 
void setSlotWidth (double v)
 
void setCurveId (QString v)
 
void setCurveKind (InletCurveKind v)
 

Constructor & Destructor Documentation

◆ InletProvider()

openswmmvis::inlet::InletProvider::InletProvider ( QString  name,
QObject *  parent = nullptr 
)
explicit

◆ ~InletProvider()

openswmmvis::inlet::InletProvider::~InletProvider ( )
overridedefault

Member Function Documentation

◆ comments()

QString openswmmvis::inlet::InletProvider::comments ( ) const
inline

◆ commentsChanged

void openswmmvis::inlet::InletProvider::commentsChanged ( )
signal
Here is the caller graph for this function:

◆ curbHeight()

double openswmmvis::inlet::InletProvider::curbHeight ( ) const
inlinenoexcept

◆ curbLength()

double openswmmvis::inlet::InletProvider::curbLength ( ) const
inlinenoexcept

◆ curveId()

QString openswmmvis::inlet::InletProvider::curveId ( ) const
inline

◆ curveKind()

InletCurveKind openswmmvis::inlet::InletProvider::curveKind ( ) const
inlinenoexcept

◆ design()

const InletDesignData & openswmmvis::inlet::InletProvider::design ( ) const
inlinenoexcept

Whole-design snapshot (undo + engine flush).

Here is the caller graph for this function:

◆ grateLength()

double openswmmvis::inlet::InletProvider::grateLength ( ) const
inlinenoexcept

◆ grateType()

GrateType openswmmvis::inlet::InletProvider::grateType ( ) const
inlinenoexcept

◆ grateWidth()

double openswmmvis::inlet::InletProvider::grateWidth ( ) const
inlinenoexcept

◆ name()

QString openswmmvis::inlet::InletProvider::name ( ) const
inlinenoexcept

◆ nameChanged

void openswmmvis::inlet::InletProvider::nameChanged ( QString  prev,
QString  now 
)
signal
Here is the caller graph for this function:

◆ openArea()

double openswmmvis::inlet::InletProvider::openArea ( ) const
inlinenoexcept

◆ paramsChanged

void openswmmvis::inlet::InletProvider::paramsChanged ( )
signal
Here is the caller graph for this function:

◆ setComments()

void openswmmvis::inlet::InletProvider::setComments ( QString  text)
Here is the call graph for this function:

◆ setCurbHeight()

void openswmmvis::inlet::InletProvider::setCurbHeight ( double  v)
Here is the call graph for this function:

◆ setCurbLength()

void openswmmvis::inlet::InletProvider::setCurbLength ( double  v)
Here is the call graph for this function:

◆ setCurveId()

void openswmmvis::inlet::InletProvider::setCurveId ( QString  v)
Here is the call graph for this function:

◆ setCurveKind()

void openswmmvis::inlet::InletProvider::setCurveKind ( InletCurveKind  v)
Here is the call graph for this function:

◆ setDesign()

void openswmmvis::inlet::InletProvider::setDesign ( const InletDesignData d)

Replace every design field at once. Emits paramsChanged() once if anything actually changed.

Here is the call graph for this function:

◆ setGrateLength()

void openswmmvis::inlet::InletProvider::setGrateLength ( double  v)
Here is the call graph for this function:

◆ setGrateType()

void openswmmvis::inlet::InletProvider::setGrateType ( GrateType  v)
Here is the call graph for this function:

◆ setGrateWidth()

void openswmmvis::inlet::InletProvider::setGrateWidth ( double  v)
Here is the call graph for this function:

◆ setName()

void openswmmvis::inlet::InletProvider::setName ( QString  newName)
Here is the call graph for this function:

◆ setOpenArea()

void openswmmvis::inlet::InletProvider::setOpenArea ( double  v)
Here is the call graph for this function:

◆ setSlotLength()

void openswmmvis::inlet::InletProvider::setSlotLength ( double  v)
Here is the call graph for this function:

◆ setSlotWidth()

void openswmmvis::inlet::InletProvider::setSlotWidth ( double  v)
Here is the call graph for this function:

◆ setSplashVeloc()

void openswmmvis::inlet::InletProvider::setSplashVeloc ( double  v)
Here is the call graph for this function:

◆ setThroat()

void openswmmvis::inlet::InletProvider::setThroat ( ThroatType  v)
Here is the call graph for this function:

◆ setType()

void openswmmvis::inlet::InletProvider::setType ( InletType  v)
Here is the call graph for this function:

◆ slotLength()

double openswmmvis::inlet::InletProvider::slotLength ( ) const
inlinenoexcept

◆ slotWidth()

double openswmmvis::inlet::InletProvider::slotWidth ( ) const
inlinenoexcept

◆ splashVeloc()

double openswmmvis::inlet::InletProvider::splashVeloc ( ) const
inlinenoexcept

◆ throat()

ThroatType openswmmvis::inlet::InletProvider::throat ( ) const
inlinenoexcept

◆ type()

InletType openswmmvis::inlet::InletProvider::type ( ) const
inlinenoexcept

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