Positionerpositioncompareenable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.274

PositionerPositionCompareEnable

Name
PositionerPositionCompareEnable – Enables the position compare mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner (must not be a secondary positioner): (-8)
- Checks the encoder ("AquadB" or "AnalogInterpolated"): (-8)
- Checks the positioner name: (-18)
- Checks the group state (must be READY): (-22)
- Checks the position compare parameters (must be configured): (-22)
Description
This function enables the position compare mode. The group must be in READY state
to use this function else (-22) error is returned.
If the position compare parameters are not configured (by the
"PositionerPositionCompareSet" function) then (-22) error is returned.
For a more thorough description of the position compare output, please refer to the XPS
Motion Tutorial section Triggers/Position Compare Output.
Prototype
int PositionerPositionCompareEnable(
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.
• -22: Not allowed action.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
413
Programmer's Manual
EDH0373En1023 — 01/18