msm_BBoundary

tables.auto_generated.msm_BBoundary

Classes

Name	Description
msm_BBoundaryTable	Table for msm_BBoundary (Boundary conditions).
msm_BBoundaryTableColumns	Column names for msm_BBoundary (Boundary conditions).

msm_BBoundaryTable

tables.auto_generated.msm_BBoundary.msm_BBoundaryTable(net_table)

Table for msm_BBoundary (Boundary conditions).

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_BBoundary.msm_BBoundaryTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.msm_BBoundary.msm_BBoundaryTable.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_BBoundary.msm_BBoundaryTable.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_BBoundary.msm_BBoundaryTable.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_BBoundary.msm_BBoundaryTable.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_BBoundaryTableColumns

tables.auto_generated.msm_BBoundary.msm_BBoundaryTableColumns(table)

Column names for msm_BBoundary (Boundary conditions).

Attributes

Name	Description
ApplyBoundaryNo	Apply
CatchID	Catchment ID
CatchLoadNo	CatchLoadNo
Chainage	Chainage [m]
ConnectionTypeNo	Connection type
ConstantDicrctionValue	Constant value [deg]
ConstantValue	Constant value
CyclicValue	Cyclic Value
DPProfileID	Profile ID
DataTypeName	Data type
DataTypeNameDicrction	Data type
Description	Description
Distance	Distance
DistributeNo	DistributeNo
FlowTypeNo	Flow type
Fraction	Scale factor [()]
GridTypeNo	GridTypeNo
GroupNo	Group No
LinkID	Link ID
ListName	List Name
LoadCategoryNo	Load category
LoadTypeNo	Load type
MUID	ID
NodeID	Node ID
RiverLocationNo	Location
RiverMuid	RiverMuid
RiverQHRelation	Q/h relation
RiverSrcDSChainage	Downstr. chainage [m]
RiverSrcTypeNo	Source type
RiverSrcUSChainage	Upstr. chainage [m]
SourceLocationNo	SourceLocationNo
SourceXCoor	X [m]
SourceYCoor	Y [m]
StartupNo	Gradual start up
StartupTime	Time [sec]
StartupValue	From
StorageID	Storage ID
TSConnTypeNo	Connection type
TSConnection	File name
TSConnectionDicrction	File name
TimeseriesName	Time series ID
TimeseriesNameDicrction	Time series ID
TypeNo	Type
ValidityBegin	Validity Start
ValidityEnd	Validity End
ValidityIntervalNo	Use limited validity interval
VariationDicrctionNo	Variation No
VariationNo	Variation No