mrm_Dambreak

tables.auto_generated.mrm_Dambreak

Classes

Name	Description
mrm_DambreakTable	Table for mrm_Dambreak (Dambreak).
mrm_DambreakTableColumns	Column names for mrm_Dambreak (Dambreak).

mrm_DambreakTable

tables.auto_generated.mrm_Dambreak.mrm_DambreakTable(net_table)

Table for mrm_Dambreak (Dambreak).

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_Dambreak.mrm_DambreakTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mrm_Dambreak.mrm_DambreakTable.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_Dambreak.mrm_DambreakTable.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_Dambreak.mrm_DambreakTable.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_Dambreak.mrm_DambreakTable.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_DambreakTableColumns

tables.auto_generated.mrm_Dambreak.mrm_DambreakTableColumns(table)

Column names for mrm_Dambreak (Dambreak).

Attributes

Name	Description
ActiveDateTime	Active date time
ApplyChainage	Breach chainage
ApplyFactorNo	Apply flow factor
ApplyLimitingNo	Apply limiting section
ApplyRiverID	River ID
ApplySCoordinate	S-coordinate of breach’s center [m]
ApplyTopoID	Topo ID
BreachFormulATypeNo	Breach formula
BreachLevelConstant	Breach level constant [m]
BreachLevelItem	Breach level item
BreachLevelPath	Breach level path
BreachLevelTypeNo	Breach level type
BreachWidthConstant	Breach width constant [m]
BreachWidthItem	Breach width item
BreachWidthPath	Breach width path
BreachWidthTypeNo	Breach width type
CalibrationCoeff	Calibration coefficient [()]
Chainage	Chainage [m]
CollapseRatio	Collapse ratio (D/y) [()]
CrestLength	Creast length before failure [m]
CrestLevel	Creast level before failure [m]
CriticalStress	Critical shear stress [N/m^2]
DataSource	Data source
Description	Description
DownstreamSlope	Downstream slope [()]
Element_S	Status
Enabled	Apply
FactorValue	Flow factor [()]
FailureModeTypeNo	Failure mode
FailureMomentHours	Failure moment hours after start [h]
FailureMomentTypeNo	Failure moment type
GrainDiameter	Grain diameter [m]
InitialDiameter	Initial diameter [m]
InitialFailureTypeNo	Type of initial failure
InitialLevel	Initial level [m]
InitialWidth	Initial width [m]
MUID	ID
MaxBottomWidth	Minimum bottom width [m]
MaxBreachSlope	Maximum breach slope [()]
MinBottomLevel	Minimum bottom level [m]
NegFreeOverflow	Negative free overflow
NegInflow	Negative Inflow
NegOutflow	Negative Outflow
PipeLevelConstant	Pipe level constant [m]
PipeLevelItem	Pipe level item
PipeLevelPath	Pipe level path
PipeLevelTypeNo	Pipe level type
Porosity	Porosity [()]
PosFreeOverflow	Positive free overflow
PosInflow	Positive Inflow
PosOutflow	Positive Outflow
RiverID	River ID
Roughness	Roughness [m]
SideErosionIndex	Side erosion index [()]
SlopeConstant	Slope constant [()]
SlopeItem	Slope item
SlopePath	Slope path
SlopeTypeNo	Slope type
SpecificGravity	Specific gravity [()]
StartingLevel	Starting level [m]
TopWidth	Top width [m]
UpstreamSlope	Upstream slope [()]
VolumeLossRatio	Volume loss ratio [()]
WaterLevel	ReservoirWL [m]