geAddInstProbe

geAddInstProbe( 
[ w_windowId ] 
[ l_lpp ] 
[ lt_probeSpec ] 
)
=> o_probe 

Description

Adds an instance probe to a window.

The instance probe is displayed using the attributes of layer-purpose pair l_lpp. If l_lpp is defaulted, a layer-purpose pair is chosen from the reserved layers y0 through y9 with purpose drawing.

These default probing layers are cycled through so that successive probes can be highlighted in different colors. Any of the geAdd*Probe functions causes the layer to cycle to the next one. geSetProbeUserLPP overrides this layer rotation.

lt_probeSpec is either a point or a string. If a point is specified, the instance at that location is probed. If a string is specified, the instance with that hierarchical path name is probed. The string should be in the format of
“/instname/instname/ .../objectName.” If lt_probeSpec is not specified, you are prompted to select an instance to probe.

Arguments

w_windowId	Database ID of the window in which to add the probe. The current window is used if w_windowId is defaulted.
l_lpp	Layer-purpose pair on which to display the probe.
lt_probeSpec	Location in user units to probe at, or a string describing the probed object.

Value Returned

o_probe

The probe object created.

Examples

Prompts you for a point, and creates an instance probe in window(3) using layer (y0 drawing).

m = geAddInstProbe( window(3) list( "y0" "drawing" ) )

Related Topics

Probe Functions

geSetProbeUserLPP

Return to top