pytuflow.BCTablesCheck.data_types

pytuflow.BCTablesCheck.data_types#

BCTablesCheck.data_types(filter_by=None, bndry_type=True)#

Returns all the available data types for the given context.

The context is an optional input that can be used to filter the return further. Valid contexts for this class are:

  • None - no filtering, returns all the data types in the file.

Boundary Type

  • [type] - returns all the times for a given boundary type (e.g. QT)

Data Type

  • [data_type] - returns all the times for a given data type (e.g. flow)

Combine contexts:

  • [context1]/[context2] ...: Combine multiple contexts to filter the times further (use / delim).

Parameters:

  • filter_by (str, optional) – Context to filter the IDs.

  • bndry_type (bool, optional) – Return the boundary type instead of the data type. e.g. return QT rather than flow. Default is True.

Returns:

List of available IDs.

Return type:

list[str]

Examples

Get all the QT boundary IDs:

>>> bndry = BCTablesCheck('path/to/_bc_tables_check.csv')
>>> bndry.ids('QT')
['FC01']

Get all the inflow IDs (QT and SA types):

>>> bndry.ids('flow')
['FC01', 'FC04']
Contents