msm_Weir

tables.auto_generated.msm_Weir

Classes

Name	Description
msm_WeirTable	Table for msm_Weir (Weirs).
msm_WeirTableColumns	Column names for msm_Weir (Weirs).

msm_WeirTable

tables.auto_generated.msm_Weir.msm_WeirTable(net_table)

Table for msm_Weir (Weirs).

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_Weir.msm_WeirTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.msm_Weir.msm_WeirTable.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_Weir.msm_WeirTable.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_Weir.msm_WeirTable.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_Weir.msm_WeirTable.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_WeirTableColumns

tables.auto_generated.msm_Weir.msm_WeirTableColumns(table)

Column names for msm_Weir (Weirs).

Attributes

Name	Description
AngleNo	Orientation
AssetName	Asset ID
Coeff	Discharge coeff.
ControlTypeNo	Controlled by control rules
CrestLevel	Crest level [m]
CrestWidth	Crest width [m]
DataSource	Data source
Description	Description
Element_S	Status
Enabled	Apply
FlapNo	Non return flap
FromNodeID	From node
InitialLevel	Initial level [m]
MUID	ID
MaxCrestLevel	Max. level [m]
MaxCrestLevelDecreaseSpeed	Max. speed down [m/s]
MaxCrestLevelIncreaseSpeed	Max. speed up [m/s]
MinCrestLevel	Min. level [m]
NetTypeNo	Network type
QHID	Q-H table
SHAPE_Length	Shape length [m]
ToNodeID	To node
TypeNo	Computational method
WeirCrestID	Crest shape