Setjogvelocity - Newport XPS Programmer's Manual

XPS Unified
7.2.2.30

SetJogVelocity

Name
SetJogVelocity – Changes "on the fly" the velocity in the jog mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Group must be "XY": (-8)
- Checks the positioner name: (-18)
- Checks the group name: (-19)
- Group status must be "JOGGING": (-22)
Description
This function allows changing "on the fly" the velocity used by the jog mode in the XY
group. If an error occurs, each positioner stops and the velocity value is set to zero.
To use this function, the jog mode must be enabled (the call of the "StartJog" function is
required). If the group status is not "JOGGING" then the (-22) error is returned.
If a slave error or a following error is detected during the jog setting then the (-25) error
or (-44) error is returned. In this case, the motion is stopped, the jog mode is disabled
and the group status becomes "DISABLE".
Prototype
int SetJogVelocity(
int SocketID,
double Xvelocity,
double Yvelocity,
int joystickAckTimeout_ms
)
Input parameters
SocketID
Xvelocity
Yvelocity
joystickAckTimeout_ms
Output parameters
None.
NOTE
This function is available only for an XY group.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
double user jog velocity for X in µm/s.
double user jog velocity for Y in µm/s.
int user jog velocity acknowledge timeout in ms.
627
Programmer's Manual
EDH0373En1023 — 01/18