compare_material_rdescriptor
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import compare_material_rdescriptor
Signature
def compare_material_rdescriptor(target: 'ModelInput', current: 'ModelInput', *, boolean_tolerance: 'float | None' = None, output_directory: 'str | Path | None' = None, include_components: 'bool' = True) -> 'dict[str, Any]'
Description
Compute missing/excess volumes using directional cuts by default.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
target | 'ModelInput' | yes | - | Not explicitly described in the source docstring. |
current | 'ModelInput' | yes | - | Not explicitly described in the source docstring. |
boolean_tolerance | 'float | None' | no | None | Not explicitly described in the source docstring. |
output_directory | 'str | Path | None' | no | None | Not explicitly described in the source docstring. |
include_components | 'bool' | no | True | 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 compare_material_rdescriptor