Newport XPS-D - Positionerbacklashset

XPS Unified Programmer’s Manual
7.2.1.146 PositionerBacklashSet
Name
PositionerBacklashSet – Sets the backlash compensation value.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner type (must not be a secondary positioner): (-8)
- The “BacklashValue” must be positive: (-17)
Description
This function changes the backlash compensation value.
NOTE
This function can be used only if a backlash compensation is defined in “stages.ini” file
(Backlash >0) , otherwise error (-22) is returned.
Prototype
int PositionerBacklashSet(
int SocketID,
char * FullPositionerName,
double BacklashValue
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
BacklashValue double Backlash compensation value (units).
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -17: Parameter out of range or incorrect.
• -22: Not allowed action.
EDH0373En1023 — 01/18 224