make_connection_region_rconnectionregion
Kind: Function
Domain: Physical connections
Canonical import: from cadflow import make_connection_region_rconnectionregion
Signature
def make_connection_region_rconnectionregion(*, region_id: 'str', component_id: 'str', geometry_ref: 'GeometryRef', role: 'ConnectionRegionRole | str' = <ConnectionRegionRole.CONTACT: 'contact'>, metadata: 'Optional[Mapping[str, Any]]' = None) -> 'ConnectionRegion'
Description
Public function in the CadFlow physical connections API.
Other public imports
from cadflow.physical import make_connection_region_rconnectionregion
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
region_id | 'str' | yes | - | Not explicitly described in the source docstring. |
component_id | 'str' | yes | - | Not explicitly described in the source docstring. |
geometry_ref | 'GeometryRef' | yes | - | Not explicitly described in the source docstring. |
role | 'ConnectionRegionRole | str' | no | <ConnectionRegionRole.CONTACT: 'contact'> | Not explicitly described in the source docstring. |
metadata | 'Optional[Mapping[str, Any]]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'ConnectionRegion'
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 import make_connection_region_rconnectionregion