Positionergantryendreferencingpositionget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.255

PositionerGantryEndReferencingPositionGet

Name
PositionerGantryEndReferencingPositionGet – Gets the secondary axis position at
the end of group home search.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks positioner type (must be a primary positioner): (-8)
- Checks group type: (-8)
• SingleAxis.
• SingleAxisTheta.
• SingleAxisWithClamping.
• XY.
• MultipleAxes.
- Checks positioner name: (-18)
- Checks if positioner has a SecondaryPositioner (must be gantry): (-24)
- Checks if homing is done: (-109)
Description
This function gets the saved corrected Setpoint position of the secondary positioner at
the end of group home search.
Prototype
int PositionerGantryEndReferencingPositionGet(
int SocketID,
char PositionerName,
double * Position
)
Input parameters
SocketID
PositionerName
Output parameters
Position
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -24: Not available in this configuration (check hardware or configuration).
• -109: Group need to be homed at least once to use this function (distance
measured during home search).
int Socket identifier gets by the
TCP_ConnectToServer" function.
int Positioner name.
double * SecondaryPositioner Setpoint Position at the end
of home (units).
392
Programmer's Manual