pytuflow.DATCrossSections.ids

pytuflow.DATCrossSections.ids#

DATCrossSections.ids(filter_by=None)#

Returns the IDs from the cross-section layer. The filter_by argument will not have any affect.

Parameters:

filter_by (str, optional) – Not used by the Flood Modeller cross-section class.

Returns:

List of IDs.

Return type:

list[str]

Examples

Return all the cross-section IDs in the layer:

>>> xs = DATCrossSections('/path/to/model.dat')
>>> xs.ids()
['FC01.40', 'FC01.39', 'FC01.38', ..., 'FC02.01', 'FC02.01d']