Skip to main content

ToleranceRequirement

Kind: Class
Domain: Expressions, units, and tolerances
Canonical import: from cadflow import ToleranceRequirement

Signature

class ToleranceRequirement(requirement_id: 'str', target_expr_id: 'str', tolerance: 'DimensionTolerance', method: 'ToleranceMethod' = 'worst_case', name: 'str' = '', tolerance_unit: 'Unit | None' = None, target_dimension: 'Dimension | None' = None) -> None

Description

Permitted result deviations for one derived dimension.

Parameters

NameTypeRequiredDefaultSource description
requirement_id'str'yes-Not explicitly described in the source docstring.
target_expr_id'str'yes-Not explicitly described in the source docstring.
tolerance'DimensionTolerance'yes-Not explicitly described in the source docstring.
method'ToleranceMethod'no'worst_case'Not explicitly described in the source docstring.
name'str'no''Not explicitly described in the source docstring.
tolerance_unit'Unit | None'noNoneNot explicitly described in the source docstring.
target_dimension'Dimension | None'noNoneNot 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

NameTypeDefault
requirement_id'str'required
target_expr_id'str'required
tolerance'DimensionTolerance'required
method'ToleranceMethod''worst_case'
name'str'''
tolerance_unit'Unit | None'None
target_dimension'Dimension | None'None

Public members

MemberKindSignatureDescription
canonical_toleranceproperty-See the member signature.
to_dictmethod(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 ToleranceRequirement

See also