colawater.toolbox.quality_control.mains

Quality control checks relating to water mains.

Examples

res = find_nonexistent_assoc_files(wm_layer)
do_something(res)

res = find_incorrect_datasources(layer)
do_something(res)

Module Contents

Functions

find_faulty_scans(→ list[tuple[Optional[str], Ellipsis]])	Returns a list of object ID and nonexistent scan pairs for the integrated mains in the water main layer.
find_unknown_datasources(→ list[tuple[Optional[str], ...)	Returns a list of object ID and unknown/null datasource pairs for the integrated mains in the water main layer.

colawater.toolbox.quality_control.mains.find_faulty_scans(wm_layer: arcpy._mp.Layer) → list[tuple[str | None, Ellipsis]]

Returns a list of object ID and nonexistent scan pairs for the integrated mains in the water main layer.

Parameters:

wm_layer (arpcy._mp.Layer) – The water main layer.

Returns:

The list of object ID and comment field tuples.

Return type:

list[tuple[str, str]

Raises:

ExecuteError – An error ocurred in the tool execution.

colawater.toolbox.quality_control.mains.find_unknown_datasources(wm_layer: arcpy._mp.Layer) → list[tuple[str | None, Ellipsis]]

Returns a list of object ID and unknown/null datasource pairs for the integrated mains in the water main layer.

Parameters:

wm_layer (arpcy._mp.Layer) – The water main layer.

Returns:

A list of Object ID and data source field tuples corresponding to water mains from the layer.

Return type:

list[tuple[str, str]]

Raises:

ExecuteError – An error ocurred in the tool execution.