XPS Unified Programmer’s Manual
7.2.2.17 GetZone
Name
GetZone – Gets current parameters of the defined circle zone.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner name is valid: (-18)
- Not allowed due to configuration disabled: (-121)
- Not allowed because group is not initialized or not referenced: (-135)
Description
Get current parameters of the defined circle zone. A digital output is defined in the
stage.ini file. It's always available after the home search. All parameters are defined in
μm. The Radius and Hysteresis are defined to signal when going out the circle.
Prototype
int GetZone (int SocketID, double * x_center_um, double * y_center_um, double *
radius_um, double * hysteresis_um)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
Output parameters
x_center_um double * X center in µm.
y_center_um double * Y center in µm.
radius_um double * Radius in µs.
hysteresis_um double * Hysteresis in µm.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -18: PositionerName doesn't exist or unknown command.
• -121: Not allowed due to configuration disabled.
• -135: Not allowed because group is not initialized or not referenced.
EDH0373En1023 — 01/18 606
To Next Page
Loading...
Need help?
General
