Getjogacceleration - Newport XPS Programmer's Manual

XPS Unified
7.2.2.7

GetJogAcceleration

Name
GetJogAcceleration – Gets the acceleration set by "SetJogAcceleration".
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 the acceleration setting by the user to use the jog mode for one
positioner or for all positioners of the XY group.
Prototype
int GetJogAcceleration(
int SocketID,
int * XaccelerationTime_ms,
int * XsmoothFactor_ms,
int * YaccelerationTime_ms,
int * YsmoothFactor_ms
)
Input parameters
SocketID
XaccelerationTime_ms
XsmoothFactor_ms
YaccelerationTime_ms
YsmoothFactor_ms
Output parameters
None.
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.
int * User jog Acceleration time for X in ms.
int * User jog Smooth factor for X in ms.
int * User jog Acceleration time for Y in ms.
int * User jog Smooth factor for Y in ms.
595
Programmer's Manual
EDH0373En1023 — 01/18