PhysicalConnection
Kind: Class
Domain: Physical connections
Canonical import: from cadflow import PhysicalConnection
Signature
class PhysicalConnection(connection_id: 'str', connection_kind: 'PhysicalConnectionKind | str', connector_a: 'ConnectorRef', connector_b: 'ConnectorRef', behavior: 'ConnectionBehavior', regions: 'tuple[ConnectionRegion, ...]' = (), insertion_direction: 'Optional[Vec3]' = None, auxiliary_component_ids: 'tuple[str, ...]' = (), kinematic_constraint_id: 'Optional[str]' = None, name: 'Optional[str]' = None, metadata: 'dict[str, Any]' = <factory>) -> None
Description
Physical connection between two assembly component connector frames.
Other public imports
from cadflow.physical import PhysicalConnection
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 | 'ConnectionBehavior' | yes | - | Not explicitly described in the source docstring. |
regions | 'tuple[ConnectionRegion, ...]' | no | () | Not explicitly described in the source docstring. |
insertion_direction | 'Optional[Vec3]' | no | None | Not explicitly described in the source docstring. |
auxiliary_component_ids | 'tuple[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 | '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 |
|---|---|---|
connection_id | 'str' | required |
connection_kind | 'PhysicalConnectionKind | str' | required |
connector_a | 'ConnectorRef' | required |
connector_b | 'ConnectorRef' | required |
behavior | 'ConnectionBehavior' | required |
regions | 'tuple[ConnectionRegion, ...]' | () |
insertion_direction | 'Optional[Vec3]' | None |
auxiliary_component_ids | 'tuple[str, ...]' | () |
kinematic_constraint_id | 'Optional[str]' | None |
name | 'Optional[str]' | None |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, data: 'Mapping[str, Any]') -> "'PhysicalConnection'" | 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 PhysicalConnection