geMakeProbeWithLabel

geMakeProbeWithLabel( 
[ ?window w_windowId ]
[ ?name t_name ] 
[ ?object g_object ] 
[ ?otherObject g_otherObject ]
[ ?label g_label ]
[ ?probeType t_probeType ]
[ ?displayStyle t_displayStyle ]
[ ?viewTypeList l_viewTypesToCrossProbe ]
[ ?message t_messageString ]
[ ?labelName t_labelName ]
[ ?labelColor l_labelColor ]
[ ?labelOffset l_labelOffset ]
[ ?labelFont t_labelFont ]
[ ?labelFontSize f_labelFontSize ]
[ ?labelJust t_labelJust ]
[ ?labelOrient t_labelOrient ]
) 
=> o_probeObjectId 

Description

Creates a probe and gives it the specified label.

The object is highlighted when found using the display attributes of the layer specified in g_label or l_labelColor. 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 since 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.

The probe label may be specified either as g_label, which is a list of label attributes, or by specifying specific label attributes as arguments to geMakeProbeWithLabel. The latter is usually more convenient if the predefined defaults are acceptable.

A single probe can have only one of the three display arguments: color, label, or onColor, and this function sets the label 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. If a list of strings is used to specify an instance terminal name, the list must have two elements for each terminal name. The first element is a string of the instance name. The second element is a string of the terminal name.
?otherObject g_otherObject
	Second object specified only for path probes, which require two terminal objects.
?label g_label	Label of the probe. Valid Values: t_labelName, l_labelColor, l_labelOffset, t_labelFont, f_labelFontSize, t_labelJust, t_labelOrient. These attributes are the same as those that can be specified directly. The default location of the label is calculated based on the type of 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 and flight.
?viewTypeList l_viewTypesToCrossProbe
	A list of strings that indicates the view types that should be cross probed. 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.
?labelName t_labelName
	Text of probe label.
?labelColor l_labelColor
	Layer-purpose pair to be used for displaying probe label.
?labelOffset l_labelOffset
	Offset in user units from the default location to place the label.
?labelFont t_labelFont
	Name of the font to use for label.
?labelFontSize f_labelFontSize
	Height in user units for the probe label.
?labelJust t_labelJust
	Justification of the probe label.
?labelOrient t_labelOrient
	Orientation of the probe label.

Value Returned

o_probeObjectId

Database ID of the new probe object.

Examples

The following example probes terminal A1 on instance I2 of the current window.

probe = geMakeProbeWithLabel(
?window getCurrentWindow( )
?name "probe2"
?object list("I2" "A1")
?labelName "labelName"
?labelColor list("y0" "drawing")
?probeType "terminal"
?displayStyle "object"
)

The following example has the same effect as the above example.

probe = geMakeProbeWithLabel(?name "myProbe"
    ?labelName "myProbeLabel"
    ?labelColor list("y0" "drawing")
    ?labelOffset 10:10
    ?labelFont "gothic"
    ?labelFontSize 100.
    ?labelJust "centerCenter"
    ?labelOrient "R90"
    ?object list( "I1" "I2")
    ?probeType "instance")

Related Topics

Probe Functions

Probe File Format

Return to top