Setzone - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.2.38

SetZone

Name
SetZone – Sets parameters to define the 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
Set parameters to define a circle zone.
An output signal will be generated when the position is inside the circle.
The 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 SetZone (int SocketID, double x_center_um, double y_center_um, double
radius_um, double hysteresis_um)
Input parameters
SocketID
x_center_um
y_center_um
radius_um
hysteresis_um
Output parameters
None.
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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
double X center in µm.
double Y center in µm.
double Radius in µs.
double Hysteresis in µm.
636
Programmer's Manual