Newport XPS Programmer's Manual

XPS Unified Programmer’s Manual
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 int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
PositionWindow double * Position window (units).
VelocityWindow double * Velocity window (units/seconds).
CheckingTime double * Checking time (seconds).
MeanPeriod double * Mean period (seconds).
Timeout double * Motion done time out (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 402

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