Newport XPS-D - Positionercompensatedpcocurrentstatusget

XPS Unified Programmer’s Manual
7.2.1.158 PositionerCompensatedPCOCurrentStatusGet
Name
PositionerCompensatedPCOCurrentStatusGet – Gets current status of CIE08
compensated PCO pulses generation.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner name: (-18)
- Checks the positioner type: (-8)
- Checks the position encoder (“AquadB” or “AnalogInterpolated”): (-24)
- Checks the CIE board supports this function: (-115)
- Checks CIE08CompensatedPCOMode = Enabled (system.ini): (-121)
Description
This function gets the current status of CIE08 compensated PCO pulses generation.
Status possible values:
• 0: Pulses generation inactive (idle, no error)
• 1: Pulses generation activated (running)
• -1: Pulses generation aborted with errors.
Prototype
int PositionerCompensatedPCOCurrentStatusGet(
int SocketID,
char * FullPositionerName,
int * Status
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
Status int * PCO pulses generation status.
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: Incorrect file name, bad section name, or not available in this
configuration (check hardware or configuration).
• -115: Function is not supported by current hardware
• -121: Function is not allowed due to configuration disabled.
EDH0373En1023 — 01/18 240