Skip to main content

SketchConstraintDiagnostic

Kind: Class
Domain: Sketch
Canonical import: from cadflow import SketchConstraintDiagnostic

Signature

class SketchConstraintDiagnostic(constraint_id: 'Optional[str]', severity: 'str', code: 'str', message: 'str', residual: 'Optional[float]' = None) -> None

Description

Diagnostic emitted by the sketch solver.

Parameters

NameTypeRequiredDefaultSource description
constraint_id'Optional[str]'yes-Not explicitly described in the source docstring.
severity'str'yes-Not explicitly described in the source docstring.
code'str'yes-Not explicitly described in the source docstring.
message'str'yes-Not explicitly described in the source docstring.
residual'Optional[float]'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
constraint_id'Optional[str]'required
severity'str'required
code'str'required
message'str'required
residual'Optional[float]'None

Behavior and constraints

  • Instances are immutable dataclass values; update workflows return a replacement value.

Import check

from cadflow import SketchConstraintDiagnostic

See also