Positionercompensatedfastpcoenable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.149

PositionerCompensatedFastPCOEnable

Name
PositionerCompensatedFastPCOEnable – Activates the CIEFAST compensated PCO
pulses generation.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner name: (-18)
- Checks if CIEFAST compensated PCO pulses generation is enabled: (-121)
Description
This function activates the CIE Fast compensated PCO pulses generation (status
becomes running (value 1)). The pulses will be generated when the scanning positioner
moves across the predefined positions. When the last pulse is generated, the CIE Fast
compensated PCO mode will become inactive (status becomes inactive (value 0)). To
get status of the CIE Fast compensated PCO pulses generation, use
PositionerCompensatedFastPCOCurrentStatusGet() function.
Note that only the scanning positioner positions are used to fire pulses: if you prepare a
set of positions at a given location and then enable the pulses generation and start the
move from a different location, the pulses could be generated but their accuracy will be
impacted by the mapping difference between the two locations.
This function must be used after the firing pulses data preparation with the
PositionerCompensatedFastPCOPrepare(), elsewhere the function fails and the error (-
122) will be returned.
Prototype
int PositionerCompensatedFastPCOEnable(
int SocketID,
char * FullPositionerName
)
Input parameters
SocketID
FullPositionerName
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.
• -18: Positioner Name doesn't exist or unknown command.
• -22: Not allowed action.
• -115: Function is not supported by current hardware.
• -121: Function is not allowed due to configuration disabled.
• -122: Data incorrect (wrong value, wrong format, wrong order or inexistent).
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
227
Programmer's Manual
EDH0373En1023 — 01/18