SurfaceRegion
Kind: Class
Domain: Simulation handoff
Canonical import: from cadflow import SurfaceRegion
Signature
class SurfaceRegion(surface_id: 'str', component_id: 'str', geometry_refs: 'tuple[GeometryRef, ...]', role: 'SurfaceRole | str' = <SurfaceRole.CONTACT: 'contact'>, property_id: 'str | None' = None, metadata: 'dict[str, Any]' = <factory>) -> None
Description
A named set of replayable component-local BREP faces.
Other public imports
from cadflow.simulation import SurfaceRegion
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
surface_id | 'str' | yes | - | Not explicitly described in the source docstring. |
component_id | 'str' | yes | - | Not explicitly described in the source docstring. |
geometry_refs | 'tuple[GeometryRef, ...]' | yes | - | Not explicitly described in the source docstring. |
role | 'SurfaceRole | str' | no | <SurfaceRole.CONTACT: 'contact'> | Not explicitly described in the source docstring. |
property_id | 'str | None' | no | None | Not explicitly described in the source docstring. |
metadata | 'dict[str, Any]' | no | <factory> | 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 |
|---|---|---|
surface_id | 'str' | required |
component_id | 'str' | required |
geometry_refs | 'tuple[GeometryRef, ...]' | required |
role | 'SurfaceRole | str' | <SurfaceRole.CONTACT: 'contact'> |
property_id | 'str | None' | None |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'SurfaceRegion'" | See the member signature. |
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import SurfaceRegion