Newport XPS - Groupmotionstatusget

XPS Unified Programmer’s Manual
7.2.1.92 GroupMotionStatusGet
Name
GroupMotionStatusGet – Gets the motion status for one or all positioners of the
selected group.
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)
Description
Returns the motion status for one or all positioners of the selected group.
The motion status possible values are:
0: Not moving state (group status in NOT_INIT, NOT_REF or READY).
1: Busy state (positioner in moving, homing, referencing, spinning, analog tracking,
trajectory, encoder calibrating, slave mode).
Prototype
int GroupMotionStatusGet(
int SocketID,
char * GroupName,
int NbPositioners,
int * Status
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
NbPositioners int Number of positioners in the selected group.
Output parameters
Status int * Positioner status.
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.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
149 EDH0373En1023 — 01/18