result_network.ResultGlobalData
result_network.ResultGlobalData(self, data_item, global_datas, res1d)Class for wrapping ResultData global data items.
By itself it is also a dict, which contains mapping between data item quantity ID and IDataItem object.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| data_item | IDataItem | MIKE 1D IDataItem object for a global data item. | required |
| global_datas | ResultGlobalDatas object. | A wrapper object for all global data items. | required |
| res1d | Res1D | Res1D object the global data belongs to. | required |
Attributes
| Name | Description |
|---|---|
| derived_quantities | A list of available derived quantities. |
| group | The TimeSeriesIdGroup assosciated with this location. |
| quantities | A list of available quantities. |
| res1d | The Res1D instance that this location belongs to. |
Methods
| Name | Description |
|---|---|
| add_query | Add a query to ResultNetwork.queries list. |
| get_m1d_dataset | Get IRes1DDataSet object associated with ResultGlobalData. |
| get_query | Get a QueryDataGlobal for given data item. |
| read | Read the time series data for all quantities at this location into a DataFrame. |
add_query
result_network.ResultGlobalData.add_query(data_item)Add a query to ResultNetwork.queries list.
get_m1d_dataset
result_network.ResultGlobalData.get_m1d_dataset(m1d_dataitem=None)Get IRes1DDataSet object associated with ResultGlobalData.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| m1d_dataitem | IDataItem | Ignored for ResultGlobalData. | None |
Returns
| Name | Type | Description |
|---|---|---|
| IRes1DDataSet | IRes1DDataSet object associated with ResultGlobalData. |
get_query
result_network.ResultGlobalData.get_query(data_item)Get a QueryDataGlobal for given data item.
read
result_network.ResultGlobalData.read(column_mode=None)Read the time series data for all quantities at this location into a DataFrame.
Parameters
| 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 |