Positionerhardinterpolatorfactorget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.256

PositionerHardInterpolatorFactorGet

Name
PositionerHardInterpolatorFactorGet – Gets the interpolation factor for position
compare mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner (must be not a secondary positioner): (-8)
- Checks the encoder type (must be "AnalogInterpolated"): (-8)
Description
This function returns the interpolation factor of the hardware interpolator used in the
"Position Compare" mode. The interpolation factor value is defined as:
InterpolationFactor = round (EncoderScalePitch/HardInterpolatorResolution)
The encoder type must be "AnalogInterpolated" in the stages.ini file
("EncoderType" parameter).
Prototype
int PositionerHardInterpolatorFactorGet(
int SocketID,
char * FullPositionerName,
int * InterpolationFactor
)
Input parameters
SocketID
FullPositionerName
Output parameters.
InterpolationFactor
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int * interpolation factor.
393
Programmer's Manual
EDH0373En1023 — 01/18