Newport XPS Programmer's Manual

XPS Unified Programmer’s Manual
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 int Socket identifier gets by the
“TCP_ConnectToServer” function.
XaccelerationTime_ms int * User jog Acceleration time for X in ms.
XsmoothFactor_ms int * User jog Smooth factor for X in ms.
YaccelerationTime_ms int * User jog Acceleration time for Y in ms.
YsmoothFactor_ms int * User jog Smooth factor for Y in 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.
595 EDH0373En1023 — 01/18

Newport XPS Specifications

General

Controller Type	Multi-axis motion controller
Power Supply	24 VDC
Communication Interface	Ethernet
Programming Language	C, C++, .NET, LabVIEW
Supported Motor Types	Stepper
Operating System Compatibility	Windows
Axes	Up to 8 axes