msm_Link

tables.auto_generated.msm_Link

Classes

Name	Description
msm_LinkTable	Table for msm_Link (Pipes and canals).
msm_LinkTableColumns	Column names for msm_Link (Pipes and canals).

msm_LinkTable

tables.auto_generated.msm_Link.msm_LinkTable(net_table)

Table for msm_Link (Pipes and canals).

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_Link.msm_LinkTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.msm_Link.msm_LinkTable.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_Link.msm_LinkTable.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_Link.msm_LinkTable.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_Link.msm_LinkTable.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_LinkTableColumns

tables.auto_generated.msm_Link.msm_LinkTableColumns(table)

Column names for msm_Link (Pipes and canals).

Attributes

Name	Description
AssetName	Asset ID
ChainageData	ChainageData
ControlNodeAID	Ctrl. node A
ControlNodeBID	Ctrl. node B
CrsID	Shape
DataSource	Data source
Description	Description
Diameter	Diameter [m]
DwLevel	Downstream level [m]
DwLevel_C	Downstream level (C) [m]
Element_S	Element status
Enabled	Apply
FlowRegNo	Use flow regulation
FricNo	Friction type
FricTypeNo	Resistance formulation
FromNodeID	From node
FunctionID	Function ID
GeometricLength	Geometric length [m]
Grid	Grid [Integer]
GridNo	Use specified grid points number
HWCoef	H-W Coef.
Height	Height [m]
Length	Length [m]
MUID	ID
ManBott	Bottom
ManExp	Exponent
ManTop	Top
Manning	Manning
MaterialID	Material ID
MaxDx	Max dx [m]
NetTypeNo	Network type
NonReturnNo	Non return valve
PMApprNo	Pressure main pipe
RegulationTypeNo	Regulation type
Rough	Roughness [m]
RoutingDelay	RoutingDelay [min]
RoutingShape	RoutingShape [()]
RoutingTypeNo	RoutingType
Slope	Slope [%]
Slot	Slot
SlotNo	Use specified Preissmann slot ratio
SpecLocalWaveNo	Use specified local wave approximation
ToNodeID	To node
TopographyID	Topo ID
TypeNo	Link type
UpLevel	Upstream level [m]
UpLevel_C	Upstream level (C) [m]
UseRoutingNo	Used as Simple routing
WaveApproximationTypeNo	WaveApproximationTypeNo
Width	Width [m]