msm_HParB

tables.auto_generated.msm_HParB

Classes

Name	Description
msm_HParBTable	Table for msm_HParB (Parameters kinematic wave).
msm_HParBTableColumns	Column names for msm_HParB (Parameters kinematic wave).

msm_HParBTable

tables.auto_generated.msm_HParB.msm_HParBTable(net_table)

Table for msm_HParB (Parameters kinematic wave).

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.msm_HParB.msm_HParBTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.msm_HParB.msm_HParBTable.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_HParB.msm_HParBTable.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_HParB.msm_HParBTable.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_HParB.msm_HParBTable.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_HParBTableColumns

tables.auto_generated.msm_HParB.msm_HParBTableColumns(table)

Column names for msm_HParB (Parameters kinematic wave).

Attributes

Name	Description
FricTypeNo	Formulation
InfExpDryLarge	InfExpDry Large [/s]
InfExpDryMedium	InfExpDry Medium [/s]
InfExpDrySmall	InfExpDry Small [/s]
InfExpWetLarge	InfExpWet Large [/s]
InfExpWetMedium	InfExpWet Medium [/s]
InfExpWetSmall	InfExpWet Small [/s]
InfMaxLarge	InfMax Large [mm/h]
InfMaxMedium	InfMax Medium [mm/h]
InfMaxSmall	InfMax Small [mm/h]
InfMinLarge	InfMin Large [mm/h]
InfMinMedium	InfMin Medium [mm/h]
InfMinSmall	InfMin Small [mm/h]
MUID	ID
ManningFlat	Manning Flat
ManningLarge	Manning Large
ManningMedium	Manning Medium
ManningSmall	Manning Small
ManningSteep	Manning Steep
StorageFlat	Storage Flat [mm]
StorageLarge	Storage Large [mm]
StorageMedium	Storage Medium [mm]
StorageSmall	Storage Small [mm]
WetFlat	Wet Flat [mm]
WetLarge	Wet Large [mm]
WetMedium	Wet Medium [mm]
WetSmall	Wet Small [mm]
WetSteep	Wet Steep [mm]