Newport XPS-D - Positionersgammapreviousmotiontimesget

XPS Unified Programmer’s Manual
7.2.1.287 PositionerSGammaPreviousMotionTimesGet
Name
PositionerSGammaPreviousMotionTimesGet – Gets the motion and the settling time.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the profiler type (must be “SGamma”): (-8)
- Checks the positioner type (must not be a secondary positioner): (-8)
Description
This function returns the motion (setting) and settling times from the previous motion.
The motion time represents the defined time to complete the previous displacement.
The settling time represents the effective settling time for a motion done.
Description
This function gets the current SGamma profiler values that are used in displacements.
Prototype
int PositionerSGammaPreviousMotionTimesGet(
int SocketID,
char * FullPositionerName
double * SettingTime,
double * SettlingTime
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
SettingTime double * Setting time (seconds).
SettlingTime double * Settling time (seconds).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
EDH0373En1023 — 01/18 430