ConstraintReport
Kind: Class
Domain: Assembly
Canonical import: from cadflow import ConstraintReport
Signature
class ConstraintReport(solved: 'bool', grounded_component_ids: 'Tuple[str, ...]', solved_component_ids: 'Tuple[str, ...]', unsolved_component_ids: 'Tuple[str, ...]', residuals: 'Tuple[ConstraintResidual, ...]') -> None
Description
Assembly constraint inspection report.
Other public imports
from cadflow.assembly import ConstraintReport
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
solved | 'bool' | yes | - | Not explicitly described in the source docstring. |
grounded_component_ids | 'Tuple[str, ...]' | yes | - | Not explicitly described in the source docstring. |
solved_component_ids | 'Tuple[str, ...]' | yes | - | Not explicitly described in the source docstring. |
unsolved_component_ids | 'Tuple[str, ...]' | yes | - | Not explicitly described in the source docstring. |
residuals | 'Tuple[ConstraintResidual, ...]' | 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 |
|---|---|---|
solved | 'bool' | required |
grounded_component_ids | 'Tuple[str, ...]' | required |
solved_component_ids | 'Tuple[str, ...]' | required |
unsolved_component_ids | 'Tuple[str, ...]' | required |
residuals | 'Tuple[ConstraintResidual, ...]' | 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 ConstraintReport