mw_Flushing

tables.auto_generated.mw_Flushing

Classes

Name Description
mw_FlushingTable Table for mw_Flushing (Flushing analysis).
mw_FlushingTableColumns Column names for mw_Flushing (Flushing analysis).

mw_FlushingTable

tables.auto_generated.mw_Flushing.mw_FlushingTable(net_table)

Table for mw_Flushing (Flushing analysis).

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.mw_Flushing.mw_FlushingTable.delete()

Create a DELETE query for this table.

Returns
Name Type Description
DeleteQuery A new DeleteQuery object
get_muids
tables.auto_generated.mw_Flushing.mw_FlushingTable.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.mw_Flushing.mw_FlushingTable.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.mw_Flushing.mw_FlushingTable.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.mw_Flushing.mw_FlushingTable.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

mw_FlushingTableColumns

tables.auto_generated.mw_Flushing.mw_FlushingTableColumns(table)

Column names for mw_Flushing (Flushing analysis).

Attributes

Name Description
ClosedPipes Closed pipes
Description Description
EmitterCoeff Emitter coefficient
FlushingDemand Flushing demand [m^3/s]
HydrantLayer Hydrant layer
IdentifyClosedPipeNo Identify closed pipe no
IdleInterval Idle interval [h]
MUID ID
MaxFlushTimeSpan Max flush time span [min]
MinResidualPre Minimum residual pressure [m]
OutputPath Output path
PipeList Pipe list
SaftyFactor Safty factor
Sqn Sqn
StartHour Start hour [h]
StartNodeID Start node id
StartNodeList Start node list
StartNodeNo Start node no
TargetShearStr Target shear stress [N/m^2]
TargetTypeNo Target type no
TargetVelocity Target velocity [m/s]
Tolerance Tolerance
TypeNo Type
UseToleranceNo Use tolerance no
ValveLayer Valve layer