Positionerhardinterpolatorfactorset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.257

PositionerHardInterpolatorFactorSet

Name
PositionerHardInterpolatorFactorSet – Sets the interpolation factor for position
compare mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type (must be not a secondary positioner): (-8)
- Checks the encoder type (must be "AnalogInterpolated"): (-8)
- Checks input parameter value: (-17)
- Checks the positioner name: (-18)
- Checks the group state (must be NOTINIT): (-22)
Description
This function sets the interpolation factor of the hardware interpolator used in the
"PositionCompare" mode. The IP200 is updated and the position compare resolution is
set as follows:
PositionCompareResolution = EncoderScalePitch/InterpolationFactor
The "InterpolationFactor" value must be define with one of these values:
20 25
If the input interpolator factor value is different from these values then (-17) error is
returned.
The group must be NOTINIT to use this function else (-22) error is returned.
The encoder type must be "AnalogInterpolated" in the stages.ini file
("EncoderType" parameter) else the error is returned.
This function applies to XPS-Q hardware. It is kept for XPS-D and XPS-RL
backward compatibility but has no effect.
Prototype
int PositionerHardInterpolatorFactorSet(
int SocketID,
char * FullPositionerName,
int InterpolationFactor
)
Input parameters
SocketID
FullPositionerName
InterpolationFactor
Output parameters
None.
40 50
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int interpolation factor.
394
Programmer's Manual
80 100 160 200