#CHECK
We use #CHECK
statements to evaluate conditions in our designs, and then show a Pass
Add Info
or Fail
state.
Syntax
pcb-check aec-q200 (component:JITXObject):
#CHECK(
name = "Automotive rating"
description = "Check that a passive component is AEC Q200 rated"
condition = has-property?(component.aec-rating),
category = "Component Data"
subcheck-description = "Check that %_ has a defined aec-rating" % [ref(component)],
pass-message = "%_ has a property for aec-rating of %_" % [ref(component) property(component.aec-rating)],
info-message = "%_ does not have an aec-rating property attached" % [ref(component)],
locators = [instance-definition(component)]
)
#CHECK(
name = "Automotive rating"
description = "Check that a passive component is AEC Q200 rated"
condition = property(component.aec-rating) == "Q200",
category = "Component Checks"
subcheck-description = "Check that %_ is AEC Q200 rated." % [ref(component)],
pass-message = "%_ is AEC Q200 rated" % [ref(component)],
fail-message = "%_ is not AEC Q200 rated. Instead has rating %_." % [ref(component) property(component.aec-rating)],
locators = [instance-definition(component)]
)
Description
The above #CHECK
statements generate this report, when run on a component with instance nae r[0]
.
name
The name of the check
description
The top-level description of the check in the report
condition
A boolean expression that evaluates to true
or false
. This condition defines if the check passes, or fails.
category
The top-level category to organize this check in the report.
subcheck-description
A detailed description of the result of this specific #CHECK
pass-message
What should be printed in the report if condition
resolves to true
fail-message
What should be printed in the report if condition
resolves to false
and the #CHECK
describes a design error. A #CHECK
can have a fail-message
or a pass-message
but not both.
info-message
What should be printed in the report if condition
resolves to false
and the #CHECK
describes missing data. A #CHECK
can have a fail-message
or a pass-message
but not both.
locators
A list of code locators that help the reader of the report what specific aspect of the design needs attention when the #CHECK
fails.