Newport XPS-D - Groupjogmodedisable

XPS Unified Programmer’s Manual
7.2.1.85 GroupJogModeDisable
Name
GroupJogModeDisable – Disables the jog mode *
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Valids object type (group): (-8)
- Valids group name: (-19)
- Group status must be “JOGGING”: (-22)
Description
Disables the Jog mode. To use this function, the group must be in “JOGGING” state
and all positioners must be idle (i.e velocity equal to 0).
This function exits the “JOGGING” state and returns to “READY” state.
If the group state is not in “JOGGING” state, or the profiler velocity is not null, error (-
22) is returned.
NOTE
To enable the jog mode use “GroupJogModeEnable” function.
CAUTION
The jog mode cannot be used with spindle group.
Prototype
int GroupJogModeDisable(
int SocketID,
char * GroupName
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
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.
• -8: Wrong object type for this command.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
139 EDH0373En1023 — 01/18