Getcurrentposition - Newport XPS Programmer's Manual

XPS Unified
7.2.2.5

GetCurrentPosition

Name
GetCurrentPosition – Gets all current positions of X, X2 and Y.
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
Read all current positions of Y, X, X2, Y laser and X laser.
Units:
Y and X positions: µm
X1 and X2 positions: counts
Y and X laser positions: counts
Prototype
int GetCurrentPosition (int SocketID, double * y_position_um, double *
x_position_um, int * x1_position_cnts, int * x2_position_cnts, int *
y_laser_position_cnts, int * x_laser_position_cnts)
Input parameters
SocketID
Output parameters
y_position_um
x_position_um
x1_position_cnts
x2_position_cnts
y_laser_position_cnts
x_laser_position_cnts
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 * Y position in µm.
double * X position in µm.
int * X1 position in counts.
int * X2 position in counts.
int * Y laser position in counts.
int * X laser position in counts.
593
Programmer's Manual
EDH0373En1023 — 01/18