inspect_topology_neighborhood_rdescriptor
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import inspect_topology_neighborhood_rdescriptor
Signature
def inspect_topology_neighborhood_rdescriptor(model_or_path: 'BRepModel | TopoDS_Shape | str | Path', entity_id: 'str', depth: 'int' = 1, max_entities: 'int' = 100) -> 'dict[str, Any]'
Description
Return a deterministic, bounded breadth-first topology neighborhood.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
model_or_path | 'BRepModel | TopoDS_Shape | str | Path' | yes | - | Not explicitly described in the source docstring. |
entity_id | 'str' | yes | - | Not explicitly described in the source docstring. |
depth | 'int' | no | 1 | Not explicitly described in the source docstring. |
max_entities | 'int' | no | 100 | 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_topology_neighborhood_rdescriptor