mrm_Weir

tables.auto_generated.mrm_Weir

Classes

Name	Description
mrm_WeirTable	Table for mrm_Weir (Weirs).
mrm_WeirTableColumns	Column names for mrm_Weir (Weirs).

mrm_WeirTable

tables.auto_generated.mrm_Weir.mrm_WeirTable(net_table)

Table for mrm_Weir (Weirs).

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.mrm_Weir.mrm_WeirTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mrm_Weir.mrm_WeirTable.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.mrm_Weir.mrm_WeirTable.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.mrm_Weir.mrm_WeirTable.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.mrm_Weir.mrm_WeirTable.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

mrm_WeirTableColumns

tables.auto_generated.mrm_Weir.mrm_WeirTableColumns(table)

Column names for mrm_Weir (Weirs).

Attributes

Name	Description
AllowRecalculationNo	Allow for recalculation
ApplyFactorNo	Apply flow factor
Chainage	Chainage [m]
Coeff	Weir coefficient [()]
CrestLevel	Crest level [m]
DataSource	Data source
Datum	Datum [m]
Description	Description
Element_S	Status
Enabled	Apply
ExpoCoeff	Weir exponential coefficient [()]
FactorValue	Flow factor [()]
GeomChainage	Geometry chainage [m]
GeomHeight	Height [m]
GeomLinkID	Geometry link name
GeomTopoID	Geometry topo ID
GeomType	Geometry type
GeomWidth	Width [m]
HeadLossCmTypeNo	Computational method
HorizOffset	Horizontal offset from marker 2 [m]
IO_Alpha	Alpha
IO_Beta	Beta
IO_q	q
InvertLevel	Invert level [m]
LinkID	River ID
MUID	ID
NegFreeOverflow	Negative free overflow
NegInflow	Negative inflow
NegOutflow	Negative outflow
NoQhRelations	No of Q/h relations
NonReturnNo	Non return flap
NonReturnTypeNo	Non return flap type
PO_a	a
PO_b	b
PO_i	(hd/hu) i
PO_p	p
PosFreeOverflow	Positive free overflow
PosInflow	Positive inflow
PosOutflow	Positive outflow
SO_Delta	Delta
SO_Gamma	Gamma
SO_r	r
SO_s	(hd/hu) s
TypeNo	Weir type