add_rack_pinion_constraint_rassembly
Kind: Function
Domain: Assembly
Canonical import: from cadflow import add_rack_pinion_constraint_rassembly
Signature
def add_rack_pinion_constraint_rassembly(assembly: 'Assembly', constraint_id: 'str', rack_connector: 'ConnectorRef', pinion_connector: 'ConnectorRef', pitch_radius: 'float', phase_offset: 'Optional[float]' = None, name: 'Optional[str]' = None) -> 'Assembly'
Description
Couple a prismatic rack axis to a revolute pinion axis.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
assembly | 'Assembly' | yes | - | Not explicitly described in the source docstring. |
constraint_id | 'str' | yes | - | Not explicitly described in the source docstring. |
rack_connector | 'ConnectorRef' | yes | - | Not explicitly described in the source docstring. |
pinion_connector | 'ConnectorRef' | yes | - | Not explicitly described in the source docstring. |
pitch_radius | 'float' | yes | - | 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. |
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 add_rack_pinion_constraint_rassembly