msm_Node

tables.auto_generated.msm_Node

Classes

Name Description
msm_NodeTable Table for msm_Node (Nodes).
msm_NodeTableColumns Column names for msm_Node (Nodes).

msm_NodeTable

tables.auto_generated.msm_Node.msm_NodeTable(net_table)

Table for msm_Node (Nodes).

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_downstream_links Get links MUIDs where specified node MUID is the downstream node.
get_muids Get a list of MUIDs for the table.
get_number_of_links Get the number of links connected to a node.
get_number_of_links_enabled Get the number of enabled links connected to a node.
get_upstream_links Get link MUIDs where specified node MUID is the upstream node.
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_Node.msm_NodeTable.delete()

Create a DELETE query for this table.

Returns
Name Type Description
DeleteQuery A new DeleteQuery object
get_muids
tables.auto_generated.msm_Node.msm_NodeTable.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_Node.msm_NodeTable.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_Node.msm_NodeTable.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_Node.msm_NodeTable.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_NodeTableColumns

tables.auto_generated.msm_Node.msm_NodeTableColumns(table)

Column names for msm_Node (Nodes).

Attributes

Name Description
AssetName Asset ID
BranchChainage Location [m]
BranchID River ID
BufferPressure Buffer pressure [m]
CoverTypeNo Cover type
CriticalLevel Critical level [m]
DataSource Data source
Description Description
Diameter Diameter [m]
EffAreaNo Effect flow area
Element_S Status
Enabled Apply
GeomX X [m]
GeomY Y [m]
GeometryID Basin geometry
GroundLevel Ground level [m]
InfConstValue Infiltration rate [m/d]
InfiltrationNo Infiltration method
InitialWL Initial water level [m]
InletControlNo Use maximum inflow
InvertLevel Bottom level [m]
KfsBottom Kfs, bottom [m/d]
KfsBottomNo Use kfs, bottom
KfsSide Kfs, side [m/d]
LossCoeffContraction Loss coefficient contraction
LossCoeffKm Loss coefficient Km
LossCoeffTotal Loss coefficient total
LossParID Head loss
LossParNo Use local parameters
LossTypeNo Loss type
MUID ID
ManholeCoverDisplacementID Displacement table ID
MaxInlet Max inlet [m^3/s]
NetTypeNo Network type
OutletQHID QH relation
PMLevel Tail level [m]
PMTypeNo Pressurized tail node
PorosityFill Porosity of fill material
QHTypeNo Use QH relation
SpillCoef Spill coefficient
SubModelNo Model
TypeNo Node type