BRepModel
Kind: Class
Domain: Inspection
Canonical import: from cadflow.inspect.brep import BRepModel
Signature
class BRepModel(root: 'TopoDS_Shape', source: 'str | None', bodies: 'tuple[TopoDS_Solid, ...]', faces: 'tuple[TopoDS_Face, ...]', edges: 'tuple[TopoDS_Edge, ...]', vertices: 'tuple[TopoDS_Vertex, ...]', adjacency: 'dict[str, set[str]]', _maps: 'dict[EntityKind, TopTools_IndexedMapOfShape]') -> None
Description
One BREP with deterministic zero-based topology ids and incidence data.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
root | 'TopoDS_Shape' | yes | - | Not explicitly described in the source docstring. |
source | 'str | None' | yes | - | Not explicitly described in the source docstring. |
bodies | 'tuple[TopoDS_Solid, ...]' | yes | - | Not explicitly described in the source docstring. |
faces | 'tuple[TopoDS_Face, ...]' | yes | - | Not explicitly described in the source docstring. |
edges | 'tuple[TopoDS_Edge, ...]' | yes | - | Not explicitly described in the source docstring. |
vertices | 'tuple[TopoDS_Vertex, ...]' | yes | - | Not explicitly described in the source docstring. |
adjacency | 'dict[str, set[str]]' | yes | - | Not explicitly described in the source docstring. |
_maps | 'dict[EntityKind, TopTools_IndexedMapOfShape]' | 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 |
|---|---|---|
root | 'TopoDS_Shape' | required |
source | 'str | None' | required |
bodies | 'tuple[TopoDS_Solid, ...]' | required |
faces | 'tuple[TopoDS_Face, ...]' | required |
edges | 'tuple[TopoDS_Edge, ...]' | required |
vertices | 'tuple[TopoDS_Vertex, ...]' | required |
adjacency | 'dict[str, set[str]]' | required |
_maps | 'dict[EntityKind, TopTools_IndexedMapOfShape]' | required |
_material_union_cache | 'TopoDS_Shape | None' | None |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
adjacency_details | method | (self, entity_id: 'str') -> 'dict[str, Any]' | See the member signature. |
describe_entity | method | (self, entity_id: 'str', *, include_curve_definition: 'bool' = False, include_surface_definition: 'bool' = False, max_surface_control_points: 'int' = 256) -> 'dict[str, Any]' | See the member signature. |
direct_neighbors | method | (self, entity_id: 'str') -> 'list[str]' | See the member signature. |
entity_list | method | (self, kind: 'EntityKind') -> 'Sequence[TopoDS_Shape]' | See the member signature. |
from_shape | class method | (cls, shape: 'TopoDS_Shape', *, source: 'str | Path | None' = None) -> "'BRepModel'" | See the member signature. |
id_for_shape | method | (self, kind: 'EntityKind', shape: 'TopoDS_Shape') -> 'str' | See the member signature. |
parameter_groups | method | (self, *, max_groups: 'int' = 24, examples_per_group: 'int' = 3) -> 'dict[str, Any]' | Return bounded scalar carrier groups without inferring a pattern. |
resolve_entity | method | (self, entity_id: 'str') -> 'tuple[EntityKind, int, TopoDS_Shape]' | See the member signature. |
summary | method | (self, *, include_parameter_groups: 'bool' = False, max_parameter_groups: 'int' = 24, examples_per_group: 'int' = 3) -> 'dict[str, Any]' | See the member signature. |
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 BRepModel