Newport XPS-D - Groupjogparametersget

XPS Unified Programmer’s Manual
7.2.1.87 GroupJogParametersGet
Name
GroupJogParametersGet – Gets the velocity and acceleration set by
“GroupJogParametersSet”.
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
This function returns the velocity and acceleration in jog mode set by the user for one
positioner or for all positioners of the selected group.
It must be called when the group is in “JOGGING” mode, otherwise both the velocity
and the acceleration will be null.
To change the velocity and the acceleration on the fly in jog mode, use
“GroupJogParametersSet” function.
CAUTION
The jog mode cannot be used with spindle group.
Prototype
int GroupJogParametersGet(
int SocketID,
char * GroupName,
int NbPositioners,
double * Velocity,
double * Acceleration
)
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
Velocity double * User jog velocity array.
EDH0373En1023 — 01/18 142