BRepInspection
Kind: Class
Domain: Inspection
Canonical import: from cadflow.inspect.brep import BRepInspection
Signature
class BRepInspection(source: 'str | None', valid: 'bool', counts: 'dict[str, int]', bounding_box: 'list[float]', volume: 'float', surface_area: 'float', center_of_mass: 'list[float]', surface_type_counts: 'dict[str, int]', edge_type_counts: 'dict[str, int]', faces: 'list[dict[str, Any]]', edges: 'list[dict[str, Any]]') -> None
Description
JSON-serializable geometry and topology facts for one BREP.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
source | 'str | None' | yes | - | Not explicitly described in the source docstring. |
valid | 'bool' | yes | - | Not explicitly described in the source docstring. |
counts | 'dict[str, int]' | yes | - | Not explicitly described in the source docstring. |
bounding_box | 'list[float]' | yes | - | Not explicitly described in the source docstring. |
volume | 'float' | yes | - | Not explicitly described in the source docstring. |
surface_area | 'float' | yes | - | Not explicitly described in the source docstring. |
center_of_mass | 'list[float]' | yes | - | Not explicitly described in the source docstring. |
surface_type_counts | 'dict[str, int]' | yes | - | Not explicitly described in the source docstring. |
edge_type_counts | 'dict[str, int]' | yes | - | Not explicitly described in the source docstring. |
faces | 'list[dict[str, Any]]' | yes | - | Not explicitly described in the source docstring. |
edges | 'list[dict[str, Any]]' | yes | - | Not explicitly described in the source docstring. |
Returns
Type: None
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.
Data fields
| Name | Type | Default |
|---|---|---|
source | 'str | None' | required |
valid | 'bool' | required |
counts | 'dict[str, int]' | required |
bounding_box | 'list[float]' | required |
volume | 'float' | required |
surface_area | 'float' | required |
center_of_mass | 'list[float]' | required |
surface_type_counts | 'dict[str, int]' | required |
edge_type_counts | 'dict[str, int]' | required |
faces | 'list[dict[str, Any]]' | required |
edges | 'list[dict[str, Any]]' | required |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
write_json | method | (self, path: 'str | Path', *, indent: 'int' = 2) -> 'Path' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow.inspect.brep import BRepInspection