Positionersencoderindexdifferenceget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.240

PositionersEncoderIndexDifferenceGet

Name
PositionersEncoderIndexDifferenceGet – Gets the distance between the two index
encoders (gantry).
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the group type (must be a SingleAxis or an XY): (-8)
- Checks the positioner type (must not be a secondary positioner): (-8)
- Checks the positioner name: (-18)
- Checks the positioner type (must be "gantry"): (-24)
- Checks the positioner was at least once homed: (-109)
Description
This function returns the distance between the two encoders indexes of a "primary
positioner – secondary positioner" couple. To use this function, the positioner must be
configured in "gantry" mode else (-24) error is returned.
For further information about gantry mode, refer to the "SYSTEM – Manual
Configuration – Gantries (Secondary Positioners)" section in the XPS User's Manual.
Prototype
int PositionersEncoderIndexDifferenceGet(
int SocketID,
char * FullPositionerName
double * Distance
)
Input parameters
SocketID
FullPositionerName
Output parameters
Distance
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.
• -109: Group need to be homed at least once to use this function (distance
mesured during home search).
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Distance between the two index encoders (units).
372
Programmer's Manual