PhysicalConnectionLayer
Kind: Class
Domain: Physical connections
Canonical import: from cadflow import PhysicalConnectionLayer
Signature
class PhysicalConnectionLayer(assembly_id: 'str', connections: 'tuple[PhysicalConnection, ...]' = (), length_unit: 'str' = 'mm', force_unit: 'str' = 'N', time_unit: 'str' = 's', metadata: 'dict[str, Any]' = <factory>) -> None
Description
Immutable physical connection graph associated with one assembly.
Other public imports
from cadflow.physical import PhysicalConnectionLayer
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
assembly_id | 'str' | yes | - | Not explicitly described in the source docstring. |
connections | 'tuple[PhysicalConnection, ...]' | no | () | Not explicitly described in the source docstring. |
length_unit | 'str' | no | 'mm' | Not explicitly described in the source docstring. |
force_unit | 'str' | no | 'N' | Not explicitly described in the source docstring. |
time_unit | 'str' | no | 's' | 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 |
|---|---|---|
assembly_id | 'str' | required |
connections | 'tuple[PhysicalConnection, ...]' | () |
length_unit | 'str' | 'mm' |
force_unit | 'str' | 'N' |
time_unit | 'str' | 's' |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
connection_ids | method | (self) -> 'tuple[str, ...]' | See the member signature. |
connections_between | method | (self, component_a: 'str', component_b: 'str') -> 'tuple[PhysicalConnection, ...]' | See the member signature. |
connections_for_component | method | (self, component_id: 'str') -> 'tuple[PhysicalConnection, ...]' | See the member signature. |
from_dict | class method | (cls, data: 'Mapping[str, Any]') -> "'PhysicalConnectionLayer'" | See the member signature. |
from_json | class method | (cls, value: 'str | bytes | bytearray') -> "'PhysicalConnectionLayer'" | See the member signature. |
get_connection | method | (self, connection_id: 'str') -> 'PhysicalConnection' | See the member signature. |
SCHEMA_VERSION | constant | - | str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
to_json | method | (self, *, indent: 'Optional[int]' = None) -> 'str' | See the member signature. |
with_connection | method | (self, connection: 'PhysicalConnection') -> "'PhysicalConnectionLayer'" | See the member signature. |
without_connection | method | (self, connection_id: 'str') -> "'PhysicalConnectionLayer'" | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import PhysicalConnectionLayer