// Do not edit this file, it is autogenerated by CMake from the .md file _HKI( "### Expression functions\n" "\n" "All function parameters support simple wildcards (`*` and `?`).\n" "

\n" "\n" " A.intersectsCourtyard('')\n" "True if any part of `A` lies within the given footprint's principal courtyard.\n" "

\n" "\n" " A.intersectsFrontCourtyard('')\n" "True if any part of `A` lies within the given footprint's front courtyard.\n" "

\n" "\n" " A.intersectsBackCourtyard('')\n" "True if any part of `A` lies within the given footprint's back courtyard.\n" "

\n" "\n" " A.intersectsArea('')\n" "True if any part of `A` lies within the given zone's outline.\n" "

\n" "\n" " A.enclosedByArea('')\n" "True if all of `A` lies within the given zone's outline.\n" "\n" "NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()`\n" "where possible.\n" "

\n" "\n" " A.getField('')\n" "The value of the given field. Only footprints have fields, so a field is only returned if\n" "`A` is a footprint.\n" "

\n" "\n" " A.isPlated()\n" "True if `A` has a hole which is plated.\n" "

\n" "\n" " A.inDiffPair('')\n" "True if `A` has a net that is part of the specified differential pair.\n" "`` is the base name of the differential pair. For example, `inDiffPair('/CLK')`\n" "matches items in the `/CLK_P` and `/CLK_N` nets.\n" "

\n" "\n" " AB.isCoupledDiffPair()\n" "True if `A` and `B` are members of the same diff pair.\n" "

\n" "\n" " A.memberOfGroup('')\n" "True if `A` is a member of the given group. The name can contain wildcards.\n" "Includes nested membership.\n" "

\n" "\n" " A.memberOfFootprint('|')\n" "True if `A` is a member of a footprint matching the given reference designator or footprint\n" "ID. The parameter can contain wildcards.\n" "\n" "NB: If matching against a footprint ID is desired, the parameter must contain a ':'.\n" "

\n" "\n" " A.memberOfSheet('')\n" "True if `A` is a member of the given schematic sheet. The sheet path can contain wildcards.\n" "

\n" "\n" " A.existsOnLayer('')\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" "the canonical name (ie: `F.Cu`).\n" "\n" "NB: this returns true if `A` is on the given layer, independently\n" "of whether or not the rule is being evaluated for that layer.\n" "For the latter use a `(layer \"layer_name\")` clause in the rule.\n" "

\n" "\n" " A.hasNetclass('')\n" "True if `A` has had the given netclass assigned to it, either by an explicit netclass label \n" "or through a pattern match assignment.\n" "

\n" "\n" "" );