Endjog - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.2.2

EndJog

Name
EndJog – Disables the jog mode in the XY group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Group must be "XY": (-8)
- Checks the group name: (-19)
- Group status must be "READY": (-22)
Description
This This function disables the Jog mode for the first declared XY group. To use this
function, the group must be in the "JOGGING" state and all positioners must be idle
(means velocity must be 0).
This function allows to exit the "JOGGING" state and to come back to the "READY"
state. If the group state is not "JOGGING" or if the profiler velocity is not null then the
(-22) error is returned.
Use the "StartJog" function to enable the jog mode.
Prototype
int GetJogAcceleration(
int SocketID
)
Input parameters
SocketID
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: Not allowed due to a positioner error or hardware status.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
590
Programmer's Manual