forward_connector_rassembly
Kind: Function
Domain: Assembly
Canonical import: from cadflow import forward_connector_rassembly
Signature
def forward_connector_rassembly(assembly: 'Assembly', connector_id: 'str', source_component_id: 'str', source_connector_id: 'str', name: 'Optional[str]' = None, offset: 'Optional[Placement]' = None) -> 'Assembly'
Description
Expose an internal component connector as an assembly-level connector.
Expose an internal component connector as an assembly-level connector.
The forwarded connector resolves to source_component.placement * source_connector.placement, followed by the optional offset placement. Parent assemblies can constrain to the subassembly's public connector without depending on its private component structure.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
assembly | 'Assembly' | yes | - | Not explicitly described in the source docstring. |
connector_id | 'str' | yes | - | Not explicitly described in the source docstring. |
source_component_id | 'str' | yes | - | Not explicitly described in the source docstring. |
source_connector_id | 'str' | yes | - | Not explicitly described in the source docstring. |
name | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
offset | 'Optional[Placement]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'Assembly'
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 forward_connector_rassembly