pytuflow.FVBCTide.data_types

pytuflow.FVBCTide.data_types#

FVBCTide.data_types(filter_by=None)#

Returns all the available data types (result types) for the given filter.

The filter_by is an optional input that can be used to filter the return further. Available filters for the FVBCTide class are:

  • None: default - returns all available data types

  • 2d: same as None as class only contains 2D data

  • node / code:point: returns only node data types

  • nodestring / code:line: returns only nodestring data types

  • [id]: returns only data types for the given ID.

Parameters:

filter_by (str, optional) – The string to filter the data types by.

Returns:

The available data types.

Return type:

list[str]

Examples

>>> bndry = FVBCTide('/path/to/fv_bc_tide.nc', '/path/to/fv_bc_tide.shp')
>>> bndry.data_types()
['water level']
Contents