haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add getField() and memberOfSheet() to DRC syntax help

This commit is contained in:
Graham Keeth 2023-11-23 18:53:59 -05:00 committed by Jon Evans
parent 4e796206f9
commit 1fbdbabd08
2 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pcbnew/dialogs/panel_setup_rules_help.md
View File

@ -129,10 +129,15 @@ True if any part of `A` lies within the given zone's outline.
<br><br> <br><br>
A.enclosedByArea('<zone_name>') A.enclosedByArea('<zone_name>')
True if all of `A` lies within the given zone's outline. True if all of `A` lies within the given zone's outline.
NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()` NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()`
where possible. where possible.
<br><br>
A.getField('<field_name>')
The value of the given field. Only footprints have fields, so a field is only returned if
`A` is a footprint.
<br><br> <br><br>
A.isPlated() A.isPlated()
@ -157,6 +162,10 @@ Includes nested membership.
A.memberOfFootprint('<footprint_reference>') A.memberOfFootprint('<footprint_reference>')
True if `A` is a member of a footprint matching the given reference designator. The True if `A` is a member of a footprint matching the given reference designator. The
reference can contain wildcards. reference can contain wildcards.
<br><br>
A.memberOfSheet('<sheet_path>')
True if `A` is a member of the given schematic sheet. The sheet path can contain wildcards.
<br><br> <br><br>
A.existsOnLayer('<layer_name>') A.existsOnLayer('<layer_name>')

13
pcbnew/dialogs/panel_setup_rules_help_md.h
View File

@ -130,12 +130,17 @@ _HKI( "### Top-level Clauses\n"
"<br><br>\n" "<br><br>\n"
"\n" "\n"
" A.enclosedByArea('<zone_name>')\n" " A.enclosedByArea('<zone_name>')\n"
"True if all of `A` lies within the given zone's outline. \n" "True if all of `A` lies within the given zone's outline.\n"
"\n" "\n"
"NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()` \n" "NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()`\n"
"where possible.\n" "where possible.\n"
"<br><br>\n" "<br><br>\n"
"\n" "\n"
" A.getField('<field_name>')\n"
"The value of the given field. Only footprints have fields, so a field is only returned if\n"
"`A` is a footprint.\n"
"<br><br>\n"
"\n"
" A.isPlated()\n" " A.isPlated()\n"
"True if `A` has a hole which is plated.\n" "True if `A` has a hole which is plated.\n"
"<br><br>\n" "<br><br>\n"
@ -160,6 +165,10 @@ _HKI( "### Top-level Clauses\n"
"reference can contain wildcards.\n" "reference can contain wildcards.\n"
"<br><br>\n" "<br><br>\n"
"\n" "\n"
" A.memberOfSheet('<sheet_path>')\n"
"True if `A` is a member of the given schematic sheet. The sheet path can contain wildcards.\n"
"<br><br>\n"
"\n"
" A.existsOnLayer('<layer_name>')\n" " A.existsOnLayer('<layer_name>')\n"
"True if `A` exists on the given layer. The layer name can be\n" "True if `A` exists on the given layer. The layer name can be\n"
"either the name assigned in Board Setup > Board Editor Layers or\n" "either the name assigned in Board Setup > Board Editor Layers or\n"