Newport XPS-D - Groupvelocitycurrentget

XPS Unified Programmer’s Manual
7.2.1.110 GroupVelocityCurrentGet
Name
GroupVelocityCurrentGet – Gets the current velocity 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 current velocity for one or all positioners of the selected group.
Prototype
int GroupVelocityCurrentGet(
int SocketID,
char * GroupName,
int NbPositioners,
double * CurrentVelocity
)
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
CurrentVelocity double * Current Velocity array.
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.
173 EDH0373En1023 — 01/18