inspect_face_boundaries_rdescriptor
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import inspect_face_boundaries_rdescriptor
Signature
def inspect_face_boundaries_rdescriptor(model_or_path: 'BRepModel | TopoDS_Shape | str | Path', face_id: 'str', samples_per_edge: 'int' = 16, compact: 'bool' = False, include_curve_definitions: 'bool' = False, curve_definition_edge_ids: 'Sequence[str] | None' = None, max_total_control_points: 'int' = 256) -> 'dict[str, Any]'
Description
Return ordered outer and inner wire occurrences for one stable face id.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
model_or_path | 'BRepModel | TopoDS_Shape | str | Path' | yes | - | Not explicitly described in the source docstring. |
face_id | 'str' | yes | - | Not explicitly described in the source docstring. |
samples_per_edge | 'int' | no | 16 | Not explicitly described in the source docstring. |
compact | 'bool' | no | False | Not explicitly described in the source docstring. |
include_curve_definitions | 'bool' | no | False | Not explicitly described in the source docstring. |
curve_definition_edge_ids | 'Sequence[str] | None' | no | None | Not explicitly described in the source docstring. |
max_total_control_points | 'int' | no | 256 | Not explicitly described in the source docstring. |
Returns
Type: 'dict[str, Any]'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow.inspect.brep import inspect_face_boundaries_rdescriptor