geAddPathProbe

geAddPathProbe( 
[ w_windowId ] 
[ l_lpp ] 
[ lt_probeSpec1 ]
[ lt_probeSpec2 ] 
)
=> o_probe 

Description

Adds a path probe to a window.

The path 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 will override this layer rotation.

lt_probeSpec1 is either a point or a string. If a point is specified, then the terminal at that location becomes the first of the two terminals in the path probe. If a string is specified, then the terminal having that hierarchical path name is the first terminal. The string should be in the format “/instname/instname/ .../objectName.” If lt_probeSpec1 is defaulted, you are prompted to select the first terminal to probe. Similarly, lt_probeSpec2 either selects the second terminal, or if defaulted, causes you to be prompted to point at the second terminal.

Arguments

w_windowId	Database ID of the window to probe. The current window is used if w_windowId is defaulted.
l_lpp	Layer-purpose pair on which to display the probe.
lt_probeSpec1	Location in user units to look for the first terminal of the path at, or a string describing the first terminal.
lt_probeSpec2	Location in user units at which to look for the second terminal of the path, or a string describing the second terminal.

Value Returned

o_probe

Probe object created.

Examples

Prompts for two points, and creates a path probe between the two terminals in window(3) using the next layer in the probe layer rotation sequence.

m = geAddPathProbe( window(3) )

Related Topics

Probe Functions

geSetProbeUserLPP

Return to top