Index: doc/user/06_feature/query/functions.html =================================================================== --- doc/user/06_feature/query/functions.html (revision 32041) +++ doc/user/06_feature/query/functions.html (revision 32042) @@ -2,11 +2,12 @@
Functions listed below can be called from a query expression. -
Determine length of a list.
@@ -17,7 +18,7 @@
Return value: integer length of the list. -
Determine length of a list.
@@ -27,7 +28,9 @@
Return value: a list built of the objects passed. -
Calculate the distance of two points.
@@ -42,32 +45,56 @@ Return value: floating point distance value in nanometers. -
Returns the absolute value of a number -
-Build a DRC violation report. +Returns 1 if obj1 and obj2 overlap (even if they are on different layers)
-Arguments (a variable number of pairs of instruction and value): +Arguments:
-Instruction is one of the following constants: +Return value: 1 for overlap, 0 for no overlap. + +
+Returns 1 if obj1 and obj2 intersect (must share a layer) +
+Arguments:
-Return value: a list suitable for the drc_query to process. +Return value: 1 for intersection, 0 for no overlap. -
+Return the number of layers on which the ring of a padstack is too thin. +
+Arguments: +
+Return value: negative on wrong arguments, 0 if the padstack does not violate +the minimum_ring_thickness requirement, positive integer (number of violations) +otherwise. + + +
Return the netlist.
Arguments: None. @@ -77,7 +104,7 @@ using). Each item of the list is a net. -
Return terminals of a network.
@@ -90,7 +117,7 @@ as described by the edited netlist). -
Return terminals and all copper objects galvanically connected to a network.
@@ -102,7 +129,7 @@ Return value: an unordered list of copper objects connected to the network. -
Return a list of objects, one terminal object per disconnecte segment of the network. @@ -116,7 +143,7 @@ from each disconnected segment of the net. -
Start a search on a galvanically connected network segment starting from an object (typically returned by netsegs()) and generate a DRC violation @@ -130,7 +157,7 @@
Return value: a list that represents a DRC violation (or empty list). -
Start a search on a galvanically connected network segment starting from an object (typically returned by netsegs()) and generate a DRC violation @@ -145,7 +172,10 @@
Return value: a list that represents a DRC violation (or empty list). -
Return a list of objects that are within the subc.
@@ -156,77 +186,60 @@
Return value: an unordered list of objects. -
-Execute a pcb-rnd action. -
-Arguments: variable nunmber of objects and constants. -
-Return value: invalid on error, or the return value of the action. -
-Fetch the value of a config node +Return the number of visible polygon islands.
Arguments:
-Return value: invalid if the config node doesn't exist, else the value of -the config node (converted to the most appropriate data type). +Return value: 0 if the polygon has been cleared out of existnece, 1 for normal +polygons and a positive integer higher than 1 if the polygon has the FULLPOLY +flag and is sliced into multiple parts not naturally connected by the polygon +itself. -
-Return the number of layers on which the ring of a padstack is too thin. +Execute a pcb-rnd action.
-Arguments: -
-Return value: negative on wrong arguments, 0 if the padstack does not violate -the minimum_ring_thickness requirement, positive integer (number of violations) -otherwise. +Return value: invalid on error, or the return value of the action. -
-Return the number of visible polygon islands. +Fetch the value of a config node
Arguments:
-Return value: 0 if the polygon has been cleared out of existnece, 1 for normal -polygons and a positive integer higher than 1 if the polygon has the FULLPOLY -flag and is sliced into multiple parts not naturally connected by the polygon -itself. +Return value: invalid if the config node doesn't exist, else the value of +the config node (converted to the most appropriate data type). - -
-Returns 1 if obj1 and obj2 overlap (even if they are on different layers) +Build a DRC violation report (a list object).
-Arguments: +Arguments (a variable number of pairs of instruction and value):
-Return value: 1 for overlap, 0 for no overlap. - -
-Returns 1 if obj1 and obj2 intersect (must share a layer) -
-Arguments: +Instruction is one of the following constants:
-Return value: 1 for intersection, 0 for no overlap. - +Return value: a list suitable for the drc_query to process.