mss_Link

tables.auto_generated.mss_Link

Classes

Name	Description
mss_LinkTable	Table for mss_Link (Conduits).
mss_LinkTableColumns	Column names for mss_Link (Conduits).

mss_LinkTable

tables.auto_generated.mss_Link.mss_LinkTable(net_table)

Table for mss_Link (Conduits).

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.mss_Link.mss_LinkTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mss_Link.mss_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.mss_Link.mss_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.mss_Link.mss_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.mss_Link.mss_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

mss_LinkTableColumns

tables.auto_generated.mss_Link.mss_LinkTableColumns(table)

Column names for mss_Link (Conduits).

Attributes

Name	Description
AssetName	Asset ID
AvgLossCoeff	Average losscoeff
Barrels	Number of barrels
BottomRadius	Bottom radius [m]
BottomWidth	Bottom / Max width [m]
CulvertCode	Culvert code
DataSource	Data source
Depth	Max. height [m]
Description	Description
Element_S	Element_S
Enabled	Is active
EntryLossCoeff	Entry loss coeff
ExitLossCoeff	Exit loss coeff
Exponent	Exponent
FlapGateNo	Flap gate
ForceMainRoughnessDW	D-W roughness [mm]
ForceMainRoughnessHW	H-W roughness
FricNo	Friction type
FromNodeID	From node
GeometricLength	Geometric length [m]
InitialFlow	Initial flow [m^3/s]
InletInvert	Inlet invert elevation [m]
InletInvert_C	Inlet invert elevation (C) [m]
InletInvert_Offset	Inlet invert offset [m]
LeftSideSlope	Left side slope [%]
Length	Length [m]
MUID	ID
MaterialID	Material ID
MaxFlow	Max flow [m^3/s]
NetTypeNo	Network type
OutletInvert	Outlet invert elevation [m]
OutletInvert_C	Outlet invert elevation (C) [m]
OutletInvert_Offset	Outlet invert offset [m]
RightSideSlope	Right side slope [%]
Roughness	Manning roughness [s/m^(1/3)]
SedimentDepth	Sediment depth [m]
SeepageRate	Seepage rate [mm/h]
ShapeID	Shape ID
ShapeTypeNo	Conduit shape
SidewallsNo	Removed sidewalls
Slope	Slope [%]
Tag	Tag
ToNodeID	To node
TopWidth	Top / Max Width [m]
TransectID	Transect ID
TriangleHeight	Triangle height