Constraint
Kind: Class
Domain: Assembly
Canonical import: from cadflow import Constraint
Signature
class Constraint(constraint_id: 'str', constraint_kind: 'ConstraintKind', connector_a: 'ConnectorRef', connector_b: 'ConnectorRef', drive_distance: 'Optional[float]' = None, distance_limit: 'Optional[ScalarLimit]' = None, drive_angle_degrees: 'Optional[float]' = None, angle_limit: 'Optional[ScalarLimit]' = None, pitch_radius_a: 'Optional[float]' = None, pitch_radius_b: 'Optional[float]' = None, pulley_radius_a: 'Optional[float]' = None, pulley_radius_b: 'Optional[float]' = None, pitch_radius: 'Optional[float]' = None, phase_offset: 'Optional[float]' = None, name: 'Optional[str]' = None, _metadata: 'Dict[str, Any]' = <factory>, _runtime: 'Dict[str, Any]' = <factory>) -> None
Description
Connector-to-connector assembly constraint.
Other public imports
from cadflow.assembly import Constraint
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
constraint_id | 'str' | yes | - | Not explicitly described in the source docstring. |
constraint_kind | 'ConstraintKind' | 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. |
drive_distance | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
distance_limit | 'Optional[ScalarLimit]' | no | None | Not explicitly described in the source docstring. |
drive_angle_degrees | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
angle_limit | 'Optional[ScalarLimit]' | no | None | Not explicitly described in the source docstring. |
pitch_radius_a | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
pitch_radius_b | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
pulley_radius_a | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
pulley_radius_b | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
pitch_radius | 'Optional[float]' | no | None | Not explicitly described in the source docstring. |
phase_offset | 'Optional[float]' | 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. |
_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 |
|---|---|---|
constraint_id | 'str' | required |
constraint_kind | 'ConstraintKind' | required |
connector_a | 'ConnectorRef' | required |
connector_b | 'ConnectorRef' | required |
drive_distance | 'Optional[float]' | None |
distance_limit | 'Optional[ScalarLimit]' | None |
drive_angle_degrees | 'Optional[float]' | None |
angle_limit | 'Optional[ScalarLimit]' | None |
pitch_radius_a | 'Optional[float]' | None |
pitch_radius_b | 'Optional[float]' | None |
pulley_radius_a | 'Optional[float]' | None |
pulley_radius_b | 'Optional[float]' | None |
pitch_radius | 'Optional[float]' | None |
phase_offset | 'Optional[float]' | None |
name | 'Optional[str]' | None |
_metadata | 'Dict[str, Any]' | factory |
_runtime | 'Dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
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 Constraint