inspect_step_rsummary
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import inspect_step_rsummary
Signature
def inspect_step_rsummary(path: 'str | Path', *, include_parameter_groups: 'bool' = False, max_parameter_groups: 'int' = 24, examples_per_group: 'int' = 3) -> 'dict[str, Any]'
Description
Return global material and topology facts for one STEP file.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
path | 'str | Path' | yes | - | Not explicitly described in the source docstring. |
include_parameter_groups | 'bool' | no | False | Not explicitly described in the source docstring. |
max_parameter_groups | 'int' | no | 24 | Not explicitly described in the source docstring. |
examples_per_group | 'int' | no | 3 | 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_step_rsummary