ConstraintResidual
Kind: Class
Domain: Assembly
Canonical import: from cadflow import ConstraintResidual
Signature
class ConstraintResidual(constraint_id: 'str', translation_error: 'float', angular_error_degrees: 'float', within_tolerance: 'bool') -> None
Description
Residual for a single assembly constraint.
Other public imports
from cadflow.assembly import ConstraintResidual
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
constraint_id | 'str' | yes | - | Not explicitly described in the source docstring. |
translation_error | 'float' | yes | - | Not explicitly described in the source docstring. |
angular_error_degrees | 'float' | yes | - | Not explicitly described in the source docstring. |
within_tolerance | 'bool' | yes | - | 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 |
translation_error | 'float' | required |
angular_error_degrees | 'float' | required |
within_tolerance | 'bool' | required |
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 ConstraintResidual