Newport XPS-D - Positionerusertravellimitsset

XPS Unified Programmer’s Manual
7.2.1.296 PositionerUserTravelLimitsSet
Name
PositionerUserTravelLimitsSet – Sets the user travel limits.
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)
- Checks input parameter values: (-17)
• UserMinimumTargetPosition <UserMaximumTargetPosition.
• MinimumTargetPosition ≤UserMinimumTargetPosition
≤MaximumTargetPosition.
• MinimumTargetPosition ≤UserMaximumTargetPosition
≤MaximumTargetPosition.
• UserMinimumTargetPosition ≤ProfilerPosition.
• UserMaximumTargetPosition ≥ProfilerPosition.
- If piezo driver, check if driver is not initialized: (-118)
Description
This function sets the new user travel limits of the selected positioner.
Prototype
int PositionerUserTravelLimitsSet(
int SocketID,
char * FullPositionerName,
double UserMinimumTarget,
double UserMaximumTarget
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
UserMinimumTarget double User minimum travel limit (units).
UserMaximumTarget double User maximum travel limit (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: Wrong parameter type in the command string: double or double *
expected.
• -118: Not allowed action driver not initialized.
EDH0373En1023 — 01/18 440