pytuflow.BCTablesCheck.times

pytuflow.BCTablesCheck.times#

BCTablesCheck.times(filter_by=None, fmt='relative')#

Returns a list of unique times in the BC Tables Check file 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 times 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)

ID

  • [id] - returns all the times for a given ID (e.g. FC01)

Combine contexts:

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

Parameters:

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

  • fmt (str, optional) – Format of the times. Can be relative or absolute. Default is relative.

Returns:

List of unique times in the BC Tables Check file.

Return type:

list[TimeLike]

Examples

Get the times for boundary FC01:

>>> bndry.times('FC01')
[0.0, 0.08, 0.17 ... 3.17, 3.25, 3.33]
Contents