Getjogvelocity - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.2.8

GetJogVelocity

Name
GetJogVelocity – 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)
Description
This function returns jog velocities and the jog velocity acknowledge timeout in
milliseconds used by the jog mode in the XY group.
Prototype
int GetJogVelocity(
int SocketID,
double * Xvelocity,
double * Yvelocity,
int * joystickAckTimeout_ms
)
Input parameters
SocketID
Output parameters
Xvelocity
Yvelocity
joystickAckTimeout_ms
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: Not allowed due to a positioner error or hardware status.
• -19: GroupName doesn't exist or unknown command.
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.
596
Programmer's Manual