mw_FireFlow

tables.auto_generated.mw_FireFlow

Classes

Name	Description
mw_FireFlowTable	Table for mw_FireFlow (Fire flow analysis).
mw_FireFlowTableColumns	Column names for mw_FireFlow (Fire flow analysis).

mw_FireFlowTable

tables.auto_generated.mw_FireFlow.mw_FireFlowTable(net_table)

Table for mw_FireFlow (Fire flow 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_FireFlow.mw_FireFlowTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mw_FireFlow.mw_FireFlowTable.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_FireFlow.mw_FireFlowTable.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_FireFlow.mw_FireFlowTable.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_FireFlow.mw_FireFlowTable.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_FireFlowTableColumns

tables.auto_generated.mw_FireFlow.mw_FireFlowTableColumns(table)

Column names for mw_FireFlow (Fire flow analysis).

Attributes

Name	Description
CriFlowLimit	Critical velocity [m/s]
CriNodePre	Critical pressure [m]
CriNodeRadius	Critical node/pipe search radius [m]
DesignFlow	Design flow [m^3/s]
DesignPressure	Design pressure [m]
Duration	Duration [h]
FirHydMinorLoss	Local loss coefficient
FirHydPipeDiameter	Lateral diameter [mm]
FirHydPipeLength	Lateral length [m]
FirHydPipeRough	Lateral roughness
HydInputField	Add input field
HydLayer	Hydrant layer
HydOutField	Add result field
HydSnapTolerance	Snapping tolerance [m]
MUID	ID
NodeDemMult	Demand multiplier
NodeSelectionList	Selection ID
ReportCriPreNo	Report below critical pressure
ReportCriVelNo	Report above critical velocity
SearchZoneTypeNo	Zone type
SelHydTypeNo	Hydrant selection type
SelNodeTypeNo	Node selection type
SimFirHydNo	Simulate hydrant lateral
SimStartTime	Time start
TypeNo	Method type
UseCriFlowLimitNo	Maintain maximum velocity
UseCriNodePreNo	Maintain Minimum residual pressure
UseCriNodeRadiusNo	Critical node/pipe search type
UseHydNo	Use external hydrants data
UseNodeBelResPreNo	Skip nodes with static pressure below residual pressure
UseNodeDemMultNo	Use demand multiplier
UseSimultaneousNo	Simultaneous fire flow