msm_Catchment
tables.auto_generated.msm_Catchment
Classes
| Name | Description |
|---|---|
| msm_CatchmentTable | Table for msm_Catchment (Catchments). |
| msm_CatchmentTableColumns | Column names for msm_Catchment (Catchments). |
msm_CatchmentTable
tables.auto_generated.msm_Catchment.msm_CatchmentTable(net_table)Table for msm_Catchment (Catchments).
Attributes
| Name | Description |
|---|---|
| columns | Get the columns for the table. |
| description | Get the table description. |
| display_name | Get the display name for the table. |
| name | Get the table name. |
Methods
| Name | Description |
|---|---|
| delete | Create a DELETE query for this table. |
| get_muids | Get a list of MUIDs for the table. |
| insert | Insert a row with the given values. |
| select | Create a SELECT query for this table. |
| update | Create an UPDATE query for this table. |
delete
tables.auto_generated.msm_Catchment.msm_CatchmentTable.delete()Create a DELETE query for this table.
Returns
| Name | Type | Description |
|---|---|---|
| DeleteQuery | A new DeleteQuery object |
get_muids
tables.auto_generated.msm_Catchment.msm_CatchmentTable.get_muids(
order_by=None,
descending=False,
)Get a list of MUIDs for the table.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| order_by | str or None | Column to order the MUIDs by | None |
| descending | bool | Whether to order in descending order | False |
Returns
| Name | Type | Description |
|---|---|---|
| list of str | A list of MUIDs |
insert
tables.auto_generated.msm_Catchment.msm_CatchmentTable.insert(
values,
execute=True,
)Insert a row with the given values.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| values | dict of str to Any | Column-value pairs to insert | required |
| execute | bool | Whether to execute the query immediately (default: True) | True |
Returns
| Name | Type | Description |
|---|---|---|
| str or InsertQuery | If execute is True, returns the ID of the newly inserted row (MUID) If execute is False, returns an InsertQuery instance |
select
tables.auto_generated.msm_Catchment.msm_CatchmentTable.select(columns=[])Create a SELECT query for this table.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| columns | list of str | The columns to select | [] |
Returns
| Name | Type | Description |
|---|---|---|
| SelectQuery | A new SelectQuery object |
update
tables.auto_generated.msm_Catchment.msm_CatchmentTable.update(values)Create an UPDATE query for this table.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| values | dict of str to Any | Column-value pairs to set in the UPDATE | required |
Returns
| Name | Type | Description |
|---|---|---|
| UpdateQuery | A new UpdateQuery object |
msm_CatchmentTableColumns
tables.auto_generated.msm_Catchment.msm_CatchmentTableColumns(table)Column names for msm_Catchment (Catchments).
Attributes
| Name | Description |
|---|---|
| AddFlow | Additional flow [m^3/s] |
| AddFlowNo | Use additional flow |
| Area | Catchment area [ha] |
| AssetName | Asset ID |
| DataSource | Data source |
| Description | Description |
| Element_S | Element status |
| Enabled | Apply |
| FricTypeNo | Formulation |
| GeomArea | Geom area [ha] |
| GeomCentroidX | X coordinate [m] |
| GeomCentroidY | Y coordinate [m] |
| HydrologicalModelNo | Hydrological model |
| IncludeAutoCalNo | Include autocalibration |
| LossDefinition | Use land use distribution |
| MUID | ID |
| ModelACoeffNo | ModelA Coeff. No |
| ModelAConcTime | ModelA concentration time [min] |
| ModelAILoss | ModelA initial loss [mm] |
| ModelAImpArea | ModelA impervious area [%] |
| ModelALocalNo | ModelA use local |
| ModelAParAID | ModelA parameter ID |
| ModelARFactor | ModelA reduction factor [()] |
| ModelATACoeff | ModelA TA Coeff. |
| ModelATACurveID | ModelA TA curve ID |
| ModelBAIFlat | ModelB AI flat [%] |
| ModelBAISteep | ModelB AI steep [%] |
| ModelBAPLarge | ModelB AP large [%] |
| ModelBAPMedium | ModelB AP medium [%] |
| ModelBAPSmall | ModelB AP Small [%] |
| ModelBLength | ModelB length [m] |
| ModelBLocalNo | ModelB use local |
| ModelBMIFlat | ModelB MI flat |
| ModelBMISteep | ModelB MI steep |
| ModelBMPLarge | ModelB MP large |
| ModelBMPMedium | ModelB MP medium |
| ModelBMPSmall | ModelB MP Small |
| ModelBParBID | ModelB parameter ID |
| ModelBSlope | ModelB slope [o/oo] |
| ModelC1EffectiveArea | ModelC1 contributing area percentage [%] |
| ModelC1ILoss | ModelC1 inital loss [mm] |
| ModelC1LocalNo | ModelC1 use local |
| ModelC1ParCID | ModelC1 parameter ID |
| ModelC1TimeConst | ModelC1 time const [/h] |
| ModelC2ILoss | ModelC2 inital loss [mm] |
| ModelC2ImperviousArea | ModelC2 impervious area [%] |
| ModelC2LagTime | ModelC2 lag time [min] |
| ModelC2LocalNo | ModelC2 use local |
| ModelC2ParCID | ModelC2 parameter ID |
| ModelC2RedFactor | ModelC2 reduction factor |
| ModelC2TimeConst | ModelC2 time const [/h] |
| ModelCLength | ModelC length [m] |
| ModelCSlope | ModelC slope [o/oo] |
| ModelUHMAMC | UHM AMC |
| ModelUHMAreaFactor | UHM Contributing area fraction |
| ModelUHMBasFactor | UHM basin factor |
| ModelUHMConstLoss | UHM const loss [mm/h] |
| ModelUHMCp | UHM Cp |
| ModelUHMCurveNum | UHM curve num |
| ModelUHMHydraulicLength | UHM hydraulic length [m] |
| ModelUHMHydrographTableID | Hydrograph table |
| ModelUHMInitAbstractDepth | UHM inital abstract depth [mm] |
| ModelUHMInitLoss | UHM inital loss [mm] |
| ModelUHMLagCurveNum | UHM lag curve Num [Integer] |
| ModelUHMLagTime | UHM lag time [h] |
| ModelUHMLagTimeMethodNo | UHM lag time method |
| ModelUHMLossModelNo | ModelUHM loss model |
| ModelUHMMethodNo | UHM method |
| ModelUHMRunoffCoeff | UHM runoff Coeff. |
| ModelUHMSlope | UHM slope [%] |
| ModelUHMStreamSlope | UHM stream slope [%] |
| ModelUHMSuhCt | UHM Suh Ct |
| ModelUHMSuhL | UHM Suh L [km] |
| ModelUHMSuhLc | UHM Suh Lc [km] |
| ModelUHMSuhSlope | UHM Suh slope [%] |
| NetTypeNo | Network type |
| ParRdiiID | RDI parameter set |
| Persons | Person Equivalents [()] |
| RdiiArea | RDI contributing area percentage [%] |
| SWMM_CRegen | DWF regeneration(Curve No.) [h] |
| SWMM_Conduct | Conductivity [m/s] |
| SWMM_CurbLength | Curb length [m] |
| SWMM_DImperv | Imperv. d. storage [mm] |
| SWMM_DPerv | Perv. d. storage [mm] |
| SWMM_DecayRate | Decay rate [/s] |
| SWMM_DstorePatternID | Dstore pattern |
| SWMM_HRegen | DWF regeneration(Horton) [h] |
| SWMM_ImpervPctZero | % DCIA w/o d. storage [()] |
| SWMM_Impervious | Imperviousness [()] |
| SWMM_InfilPatternID | Infil pattern |
| SWMM_InitDef | Initial soil moisture [()] |
| SWMM_LoadToNo | Load to |
| SWMM_MaxInFil | Max infiltration vol. [mm] |
| SWMM_MaxRate | Max infiltration rate [mm/h] |
| SWMM_MinRate | Min infiltration rate [mm/h] |
| SWMM_NImperv | Impervious manning [s/m^(1/3)] |
| SWMM_NPerv | Pervious manning [s/m^(1/3)] |
| SWMM_NPervPatternID | N-perv pattern |
| SWMM_OutletCatchmentID | Outlet catchment ID |
| SWMM_OutletNodeID | Load point ID |
| SWMM_PctRouted | Percent routed [()] |
| SWMM_RaingageID | Rain gauge ID |
| SWMM_RouteToNo | Subarea routing |
| SWMM_RunoffCN | Curve number [()] |
| SWMM_Slope | Ground slope [o/oo] |
| SWMM_SnowPackID | Snowpack ID |
| SWMM_Suction | Soil capillary suction [m] |
| SWMM_Tag | Tag |
| SWMM_Width | Width [m] |