make_physical_connection_rphysicalconnection
Kind: Function
Domain: Physical connections
Canonical import: from cadflow import make_physical_connection_rphysicalconnection
Signature
def make_physical_connection_rphysicalconnection(*, connection_id: 'str', connection_kind: 'PhysicalConnectionKind | str', connector_a: 'ConnectorRef', connector_b: 'ConnectorRef', behavior: 'Optional[ConnectionBehavior]' = None, regions: 'Sequence[ConnectionRegion]' = (), insertion_direction: 'Optional[Sequence[float]]' = None, auxiliary_component_ids: 'Sequence[str]' = (), kinematic_constraint_id: 'Optional[str]' = None, name: 'Optional[str]' = None, metadata: 'Optional[Mapping[str, Any]]' = None) -> 'PhysicalConnection'
Description
Public function in the CadFlow physical connections API.
Other public imports
from cadflow.physical import make_physical_connection_rphysicalconnection
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
connection_id | 'str' | yes | - | Not explicitly described in the source docstring. |
connection_kind | 'PhysicalConnectionKind | str' | yes | - | Not explicitly described in the source docstring. |
connector_a | 'ConnectorRef' | yes | - | Not explicitly described in the source docstring. |
connector_b | 'ConnectorRef' | yes | - | Not explicitly described in the source docstring. |
behavior | 'Optional[ConnectionBehavior]' | no | None | Not explicitly described in the source docstring. |
regions | 'Sequence[ConnectionRegion]' | no | () | Not explicitly described in the source docstring. |
insertion_direction | 'Optional[Sequence[float]]' | no | None | Not explicitly described in the source docstring. |
auxiliary_component_ids | 'Sequence[str]' | no | () | Not explicitly described in the source docstring. |
kinematic_constraint_id | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
name | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
metadata | 'Optional[Mapping[str, Any]]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'PhysicalConnection'
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_physical_connection_rphysicalconnection