Positionermotiondoneget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.264

PositionerMotionDoneGet

Name
PositionerMotionDoneGet – Gets the motion done parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner (must not be a secondary positioner): (-8)
- Checks the motion done mode (must be "VelocityAndPositionWindow"): (-8)
Description
This function returns the motion done parameters only for the
"VelocityAndPositionWindow" MotionDone mode. If the MotionDone mode is defined
as "Theoretical" then (-8) error is returned.
The "MotionDoneMode" parameter from the stages.ini file defines the motion done
mode. The motion done can be defined as "Theoretical" (the motion done mode is not
used) or "VelocityAndPositionWindow". For a more thorough description of the motion
done mode, please refer to the XPS Motion Tutorial section Motion/Motion Done.
Prototype
int PositionerMotionDoneGet(
int SocketID,
char * FullPositionerName,
double * PositionWindow,
double * VelocityWindow,
double * MeanPeriod
double * Timeout
)
Input parameters
SocketID
FullPositionerName
Output parameters
PositionWindow
VelocityWindow
CheckingTime
MeanPeriod
Timeout
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Position window (units).
double * Velocity window (units/seconds).
double * Checking time (seconds).
double * Mean period (seconds).
double * Motion done time out (seconds).
402
Programmer's Manual