Index: query/functions.html =================================================================== --- query/functions.html (revision 30428) +++ query/functions.html (revision 30429) @@ -140,3 +140,76 @@

Return value: a list that represents a DRC violation (or empty list). + +

subcobjs(subc)

+

+Return a list of objects that are within the subc. +

+Arguments: +

+

+Return value: an unordered list of objects. + +

action(args...)

+

+Execute a pcb-rnd action. +

+Arguments: variable nunmber of objects and constants. +

+Return value: invalid on error, or the return value of the action. + +

getconf(path)

+

+Fetch the value of a config node +

+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). + + +

pstkring(pstk, minimum_ring_thickness)

+

+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. + +

poly_num_islands(poly)

+

+Return the number of visible polygon islands. +

+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. + + +

overlap(obj1, obj2)

+

+Returns 1 if obj1 and obj2 overlap (even if they are on different layers) +

+Arguments: +

+

+Return value: 1 for overlap, 0 for no overlap. +