result_network.ResultNode

result_network.ResultNode(self, node, res1d)

Class for wrapping a single ResultData node.

Parameters

Name	Type	Description	Default
node	IRes1DNode	MIKE 1D IRes1DNode object.	required
res1d	Res1D	Res1D object the node belongs to.	required

Name	Description
bottom_level	Bottom level of the node.
critical_level	Critical level of the node.
derived_quantities	A list of available derived quantities.
diameter	Diameter of the node.
geometry	A geometric representation of the node. Requires shapely.
ground_level	Ground level of the node.
group	The TimeSeriesIdGroup assosciated with this location.
id	Node ID.
quantities	A list of available quantities.
res1d	The Res1D instance that this location belongs to.
res1d_node	DHI.Mike1D.ResultDataAccess.IRes1DNode corresponding to this result location.
type	Node type.
xcoord	X coordinate of the node.
ycoord	Y coordinate of the node.

Name	Description
add_query	Add a query to ResultNetwork.queries list.
get_m1d_dataset	Get IRes1DDataSet object associated with ResultNode.
get_query	Get a QueryDataNode for given data item.
read	Read the time series data for all quantities at this location into a DataFrame.

result_network.ResultNode.add_query(data_item)

Add a query to ResultNetwork.queries list.

result_network.ResultNode.get_m1d_dataset(m1d_dataitem=None)

Get IRes1DDataSet object associated with ResultNode.

Name	Type	Description	Default
m1d_dataitem	IDataItem	Ignored for ResultNode.	`None`

Name	Type	Description
	IRes1DDataSet	IRes1DDataSet object associated with ResultNode.

result_network.ResultNode.get_query(data_item)

Get a QueryDataNode for given data item.

result_network.ResultNode.read(column_mode=None)

Read the time series data for all quantities at this location into a DataFrame.

Name	Type	Description	Default
column_mode	str \| ColumnMode(optional)	Specifies the type of column index of returned DataFrame. ‘all’ - column MultiIndex with levels matching TimeSeriesId objects. ‘compact’ - same as ‘all’, but removes levels with default values. ‘timeseries’ - column index of TimeSeriesId objects	`None`