Newport XPS - Positionerdriverpositionoffsetsget

XPS Unified Programmer’s Manual
7.2.1.235 PositionerDriverPositionOffsetsGet
Name
PositionerDriverPositionOffsetsGet – Gets the current value of piezo driver stage and
gage position offsets.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner type: (-8)
- Checks driver type, if not PIEZO: (-24)
- If the group state is NOTREF or READY: (-117)
- If the driver is not initialized: (-118)
Description
This function returns current value of the piezo driver position offset parameters (stage
position offset, gage position offset).
Prototype
int PositionerDriverPositionOffsetsGet(
int SocketID,
char * FullPositionerName,
double * StagePositionOffset,
double * GagePositionOffset
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
StagePositionOffset double * Driver stage position offset (units).
GagePositionOffset double * Driver gage position offset (units).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -22: Not allowed action.
• -24: Not available in this configuration (check hardware or configuration).
• -117: Function is only allowed in DISABLED state.
• -118: Not allowed action driver not initialized.
EDH0373En1023 — 01/18 366