mrm_Gate
tables.auto_generated.mrm_Gate
Classes
Name | Description |
---|---|
mrm_GateTable | Table for mrm_Gate (Gates). |
mrm_GateTableColumns | Column names for mrm_Gate (Gates). |
mrm_GateTable
tables.auto_generated.mrm_Gate.mrm_GateTable(net_table)
Table for mrm_Gate (Gates).
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.mrm_Gate.mrm_GateTable.delete()
Create a DELETE query for this table.
Returns
Name | Type | Description |
---|---|---|
DeleteQuery | A new DeleteQuery object |
get_muids
tables.auto_generated.mrm_Gate.mrm_GateTable.get_muids(=None,
order_by=False,
descending )
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
=True) tables.auto_generated.mrm_Gate.mrm_GateTable.insert(values, execute
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.mrm_Gate.mrm_GateTable.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.mrm_Gate.mrm_GateTable.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 |
mrm_GateTableColumns
tables.auto_generated.mrm_Gate.mrm_GateTableColumns(table)
Column names for mrm_Gate (Gates).
Attributes
Name | Description |
---|---|
ApplyFactorNo | Apply flow factor |
Chainage | Chainage [m] |
ContracCoef | Contraction coef. |
DataSource | Data source |
Description | Description |
Element_S | Status |
Enabled | Apply |
FactorValue | Flow factor [()] |
GateNo | Number of gates |
HeadLossCmTypeNo | Computational method |
Height | Gate height [m] |
HorizOffset | Horizontal offset from marker 2 [m] |
InitialLevel | Initial gate level [m] |
MUID | ID |
MaxLevel | Max. gate level [m] |
MaxSpeed | Max. speed [m/s] |
NegFreeflow | Negative free overflow |
NegInflow | Negative inflow |
NegOutflow | Negative outflow |
PosFreeflow | Positive free overflow |
PosInflow | Positive inflow |
PosOutflow | Positive outflow |
RadialCoef | Weir coefficient |
RadialExp | Weir exponent |
RadialFactor | Underflow factor |
RadialTranBottom | Transition bottom [m] |
RadialTranDepth | Transition depth [m] |
Radius | Radius [m] |
RiverID | River ID |
SillLevel | Sill level [m] |
Sluice_High_ContFree | Controlled free flow high limit |
Sluice_High_ContSub | Controlled submerged flow high limit |
Sluice_High_UncSub | Uncontrolled submerged flow high limit |
Sluice_Low_ContFree | Controlled free flow low limit |
Sluice_Low_ContSub | Controlled submerged flow low limit |
Sluice_Low_UncSub | Uncontrolled submerged flow low limit |
Sluice_a_ContFree | Controlled free flow coef. a |
Sluice_a_ContSub | Controlled submerged flow coef. a |
Sluice_a_UncFree | Uncontrolled free flow coef. a |
Sluice_a_UncSub | Uncontrolled submerged flow coef. a |
Sluice_b_ContFree | Controlled free flow exp. b |
Sluice_b_ContSub | Controlled submerged flow exp. b |
Sluice_b_UncSub | Uncontrolled submerged flow exp. b |
Trunnion | Trunnion [m] |
TypeNo | Gate type |
Width | Gate width [m] |