Groupmoveabort - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.93

GroupMoveAbort

Name
GroupMoveAbort – aborts the motion or the jog in progress for a group or a
positioner.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids object type (group or positioner): (-8)
- Valids positioner name: (-18)
- Valids group name: (-19)
- Group status must be "MOVING" or "JOGGING": (-22)
Description
This function aborts a motion or a jog in progress. The group state must be "MOVING"
or "JOGGING", otherwise error (-22) is returned.
For a group:
If the group status is "MOVING", this function stops all motion in progress.
If the group status is "JOGGING", this function stops all "jog" motions in progress and
disables the jog mode. After this "group move abort" action, the group status becomes
"READY".
For a positioner:
If the group status is "MOVING", this function stops the motion of the selected
positioner.
If the group status is "JOGGING", this function stops the "jog" motion of the selected
positioner.
If the positioner is idle, an error (-22) is returned.
After "positioner move abort" action, if all positioners are idle, the group status changes
to "READY", otherwise it stays in the same state.
If the "move abort" action fails, error (-27) is returned.
This error is generated when GroupMoveAbort is used to abort a motion of a
positioner in a group and the name of the positioner is incorrect.
This error will also be returned by "GroupMove" function.
Prototype
int GroupMoveAbort(
int SocketID,
char * GroupName
)
Input parameters
SocketID
GroupName
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
150
Programmer's Manual