Index: trunk/doc/user/06_feature/query/functions.html =================================================================== --- trunk/doc/user/06_feature/query/functions.html (revision 32041) +++ trunk/doc/user/06_feature/query/functions.html (revision 32042) @@ -2,11 +2,12 @@

Query: advanced search, command line: function calls available

Functions listed below can be called from a query expression. -

llen(lst)

List manipulation

+ +

llen(lst)

Determine length of a list.

@@ -17,7 +18,7 @@

Return value: integer length of the list. -

mklist(args...)

Determine length of a list.

@@ -27,7 +28,9 @@

Return value: a list built of the objects passed. -

distance(x1, y1, x2, y2)

Math & abstract geometry

+ +

distance(x1, y1, x2, y2)

Calculate the distance of two points.

@@ -42,32 +45,56 @@ Return value: floating point distance value in nanometers. -

abs(number)

Returns the absolute value of a number -

violation(i1, v1, ..., iN, vN)

+ +

Object geometry

+ +

overlap(obj1, obj2, [bloat])

-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:

i is an instruction, see below. -
v is a value (a constant or an object) +
obj1 and obj2 are objects; +
an optional bloat value, in coords: bloat up (or shrink, if negative) one of the objects by this value before the test.

-Instruction is one of the following constants: +Return value: 1 for overlap, 0 for no overlap. + +

intersect(obj1, obj2, [bloat])

+Returns 1 if obj1 and obj2 intersect (must share a layer) +

+Arguments:

DRCGRP1 - the following v is an object, part of group 1 of offending objects -
DRCGRP2 - the following v is an object, part of group 2 of offending objects -
DRCEXPECT - the following v is a numeric value that represent the expected value -
DRCMEASURE - the following v is a numeric value that represent the measured value that mismatches the expected value +
obj1 and obj2 are objects; +
an optional bloat value, in coords: bloat up (or shrink, if negative) one of the objects by this value before the test.

-Return value: a list suitable for the drc_query to process. +Return value: 1 for intersection, 0 for no overlap. -

netlist()

pstkring(pstk, minimum_ring_thickness)

+Return the number of layers on which the ring of a padstack is too thin. +

+Arguments: +

pstk is the padstack object +
minimum_ring_thickness is a coordinate value of the minimum ring thickness +

+Return value: negative on wrong arguments, 0 if the padstack does not violate +the minimum_ring_thickness requirement, positive integer (number of violations) +otherwise. + + +

Networks

+ +

netlist()

Return the netlist.

Arguments: None. @@ -77,7 +104,7 @@ using). Each item of the list is a net. -

netterms(net)

Return terminals of a network.

@@ -90,7 +117,7 @@ as described by the edited netlist). -

netobjs(net)

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

netsegs(net)

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

netbreak(obj, minimum_overlap)

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

netshort(obj, minimum_distance)

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

subcobjs(subc)

+ +

Object accessors

+ +

subcobjs(subc)

Return a list of objects that are within the subc.

@@ -156,77 +186,60 @@

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)

poly_num_islands(poly)

-Fetch the value of a config node +Return the number of visible polygon islands.

Arguments:

path is a conf node path, e.g. editor/grid +
poly is the polygon object

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

pstkring(pstk, minimum_ring_thickness)

Misc

+ +

action(args...)

-Return the number of layers on which the ring of a padstack is too thin. +Execute a pcb-rnd action.

-Arguments: -

pstk is the padstack object -
minimum_ring_thickness is a coordinate value of the minimum ring thickness -

+Arguments: variable nunmber of objects and constants.

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

poly_num_islands(poly)

getconf(path)

-Return the number of visible polygon islands. +Fetch the value of a config node

Arguments:

poly is the polygon object +
path is a conf node path, e.g. editor/grid

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

overlap(obj1, obj2, [bloat])

violation(i1, v1, ..., iN, vN)

-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):

obj1 and obj2 are objects; -
an optional bloat value, in coords: bloat up (or shrink, if negative) one of the objects by this value before the test. +
i is an instruction, see below. +
v is a value (a constant or an object)

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

intersect(obj1, obj2, [bloat])

-Returns 1 if obj1 and obj2 intersect (must share a layer) -

-Arguments: +Instruction is one of the following constants:

obj1 and obj2 are objects; -
an optional bloat value, in coords: bloat up (or shrink, if negative) one of the objects by this value before the test. +
DRCGRP1 - the following v is an object, part of group 1 of offending objects +
DRCGRP2 - the following v is an object, part of group 2 of offending objects +
DRCEXPECT - the following v is a numeric value that represent the expected value +
DRCMEASURE - the following v is a numeric value that represent the measured value that mismatches the expected value

-Return value: 1 for intersection, 0 for no overlap. - +Return value: a list suitable for the drc_query to process.