Connector
Kind: Class
Domain: Assembly
Canonical import: from cadflow import Connector
Signature
class Connector(connector_id: 'str', geometry_ref: 'Optional[GeometryRef]' = None, name: 'Optional[str]' = None, anchor: 'Optional[ConnectorAnchor]' = None, _metadata: 'Dict[str, Any]' = <factory>, _runtime: 'Dict[str, Any]' = <factory>) -> None
Description
Semantic datum frame anchored by geometry, placement, or forwarding.
Semantic datum frame anchored by geometry, placement, or forwarding.
Geometry connectors derive placement from a selected BREP sub-shape. Placement connectors store an explicit local datum frame. Forwarded connectors expose a component connector as an assembly-level public interface.
Other public imports
from cadflow.assembly import Connector
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
connector_id | 'str' | yes | - | Not explicitly described in the source docstring. |
geometry_ref | 'Optional[GeometryRef]' | no | None | Not explicitly described in the source docstring. |
name | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
anchor | 'Optional[ConnectorAnchor]' | no | None | Not explicitly described in the source docstring. |
_metadata | 'Dict[str, Any]' | no | <factory> | Not explicitly described in the source docstring. |
_runtime | '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 |
|---|---|---|
connector_id | 'str' | required |
geometry_ref | 'Optional[GeometryRef]' | None |
name | 'Optional[str]' | None |
anchor | 'Optional[ConnectorAnchor]' | None |
_metadata | 'Dict[str, Any]' | factory |
_runtime | 'Dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
anchor_kind | property | - | See the member signature. |
placement | property | - | Lazily-computed local Placement derived from the connector anchor. |
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 Connector