geMakeProbeWithColor

geMakeProbeWithColor( 
[ ?window w_windowId ]
[ ?name t_name ]
[ ?object g_object ]
[ ?otherObject g_otherObject ]
[ ?color g_color ]
[ ?probeType t_probeType ]
[ ?displayStyle t_displayStyle ] 
[ ?viewTypeList l_viewTypesToCrossProbe ] 
[ ?message t_messageString ] 
)
=> o_probeObject 

Description

Creates a probe of the specified type and gives it the specified color.

The object is highlighted when found using the display attributes of layer g_color.

The probe type can be inferred from g_object if it is an object Id and is not a terminal. A terminal can be part of either a terminal probe or a net probe, so the probe type cannot be derived in that case. If g_object is a path list, t_probeType must be specified since the type cannot be derived from the name.

A single probe can have only one of the three display arguments: color, label, or onColor, and this function sets the color attribute. A multiple probe (same object and different display argument) can specify multiple display arguments. If g_object has already been probed, the probe becomes a multiple probe.

Arguments

?window w_windowId
	Database ID of the window to contain the probe.
?name t_name	Name of the probe.
?object g_object	Object to be probed. It can be an instance, a net, or a terminal, and is specified either by the database ID of the object or by a list of strings describing a path to the object. The strings are in memInst format, which is needed for iterated instances and mosaics. If the database ID of the object is used, the path is derived from the hierarchical path from the top level of w_windowId to the object.
?otherObject g_otherObject
	Second object specified only for path probes, which require two terminal objects.
?color g_color	Layer on which to display the probe.
?probeType t_probeType
	Type of the probe. Valid Values: net, path, terminal, instance.
?displayStyle t_displayStyle
	Used to determine whether to display the probe using flight lines or objects. Display style object highlights the physical objects associated with the probe. Display style flight highlights the terminals and draws straight flight lines between the terminals of the net. If t_probe_type = net, this is the way the net is displayed. Valid Values: object, flight Default: object
?viewTypeList l_viewTypesToCrossProbe
	A list of strings that indicates the view types that should be crossProbed. If nil, no cross-probes. If a list of strings, the list of view types to cross-probe. If all, cross-probe all possible view types.
?message t_messageString
	String passed to the C-level cross probe functions.

Value Returned

o_probeObject

Database ID of the new probe object.

Examples

The following example probes instance I2 contained within instance I1 within the top level of the current window. The probe is drawn on layer y0 drawing.

probe = geMakeProbeWithColor(?name "myProbe"
?color list( "y0" "drawing")
?object list( "I1" "I2")
?probeType "instance")

The following example probes net NET10 contained within instance I5 within instance I1 within the top level of the current window. The probe is drawn on layer marker error.

probe = geMakeProbeWithColor(?name "myProbe"
    ?color list( "marker" "error")
    ?object list( "/I1/I5/NET10")
    ?probeType "net")

Related Topics

Probe Functions

Probe File Format

Return to top