geMakeProbeWithOnColor

geMakeProbeWithOnColor( 
[ ?window w_windowId ]
[ ?name t_name ]
[ ?object g_object ]
[ ?otherObject g_otherObject ]
[ ?onColor g_onColor ]
[ ?probeType t_probeType ]
[ ?displayStyle t_displayStyle ]
[ ?viewTypeList g_viewTypesToCrossProbe ]
[ ?message t_messageString ]
)
=> o_probeObjectId

Description

Creates an instance probe and gives it the specified color.

The object is highlighted when found using the display attributes of layer g_onColor. This function only works with instance probes. You can specify other types of probes, but they will not display. t_probeType can be net, path, terminal, or instance. 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 can’t be derived in that case. If g_object is a path list, t_probeType must be specified because the type cannot be derived from the name. For net probes, t_displayStyle is 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. The default display style is object.

g_viewTypesToCrossProbe is a list of strings that indicates the view types that should be cross probed. t_messageString is an optional string to be passed to C-level probe functions.

A single probe can have only one of the three display arguments: color, label, or onColor, and this function sets the onColor 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 that is 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.
?onColor g_onColor
	Layer on which to display the probe.
?probeType t_probeType
	Type of the probe. Valid Values: instance, net, path, terminal
?displayStyle t_displayStyle
	If t_probe_type = net, then this is the way the net is displayed. Valid Values: object or flight.
viewTypeList g_viewTypesToCrossProbe
	If nil, no cross-probes. If list of strings, the list of view types to cross-probe. If all, then cross-probe all possible view types.
?message t_messageString
	String passed to the C-level crossProbe functions.

Value Returned

o_probe_objectId

Database ID of the new probe object.

Examples

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

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

Related Topics

Probe Functions

Probe File Format

Return to top