Newport XPS-D - Positionercompensationdisturbanceenable

XPS Unified Programmer’s Manual
7.2.1.166 PositionerCompensationDisturbanceEnable
Name
PositionerCompensationDisturbanceEnable– Enables disturbance compensation for
selected direction (EnabledDirection = Both, Positive or Negative)
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the filter number: -17
- Checks if a disturbance compensation file is loaded: -22
Description
This function enables the compensation of disturbance for the selected direction (Both,
Positive or Negative). The disturbance compensation can be enabled only if a file was
loaded (refer to API PositionerCompensationDisturbanceFileLoad ).
Prototype
int PositionerCompensationDisturbanceEnable(
int SocketID,
char *PositionerName,
char *EnabledDirection
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
EnabledDirection char* “Both”, “Positive” or “Negative”
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: Parameter out of range or incorrect.
• -22: Not allowed action
253 EDH0373En1023 — 01/18