BRepComparison
Kind: Class
Domain: Inspection
Canonical import: from cadflow.inspect.brep import BRepComparison
Signature
class BRepComparison(target: 'str | None', candidate: 'str | None', target_minus_candidate_volume: 'float', candidate_minus_target_volume: 'float', same_geometric_point_set: 'bool', geometry_labelled_incidence_graph_isomorphic: 'bool', target_graph_nodes_edges: 'tuple[int, int]', candidate_graph_nodes_edges: 'tuple[int, int]', geometric_tolerance: 'float', boolean_volume_tolerance: 'float') -> None
Description
Hard-gate comparison facts for two solid BREPs.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
target | 'str | None' | yes | - | Not explicitly described in the source docstring. |
candidate | 'str | None' | yes | - | Not explicitly described in the source docstring. |
target_minus_candidate_volume | 'float' | yes | - | Not explicitly described in the source docstring. |
candidate_minus_target_volume | 'float' | yes | - | Not explicitly described in the source docstring. |
same_geometric_point_set | 'bool' | yes | - | Not explicitly described in the source docstring. |
geometry_labelled_incidence_graph_isomorphic | 'bool' | yes | - | Not explicitly described in the source docstring. |
target_graph_nodes_edges | 'tuple[int, int]' | yes | - | Not explicitly described in the source docstring. |
candidate_graph_nodes_edges | 'tuple[int, int]' | yes | - | Not explicitly described in the source docstring. |
geometric_tolerance | 'float' | yes | - | Not explicitly described in the source docstring. |
boolean_volume_tolerance | 'float' | 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 |
|---|---|---|
target | 'str | None' | required |
candidate | 'str | None' | required |
target_minus_candidate_volume | 'float' | required |
candidate_minus_target_volume | 'float' | required |
same_geometric_point_set | 'bool' | required |
geometry_labelled_incidence_graph_isomorphic | 'bool' | required |
target_graph_nodes_edges | 'tuple[int, int]' | required |
candidate_graph_nodes_edges | 'tuple[int, int]' | required |
geometric_tolerance | 'float' | required |
boolean_volume_tolerance | 'float' | required |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
hard_gate_passed | property | - | See the member signature. |
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 BRepComparison