XPS Unified Programmer’s Manual
7.2.1.265 PositionerMotionDoneSet
Name
PositionerMotionDoneSet – Sets the motion done parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner type: (-8)
- Checks parameter value: (-17)
Description
This function updates the motion done parameters only for the
“VelocityAndPositionWindow” MotionDone mode. The “MotionDoneMode”
parameter from the stages.ini file must be defined as “VelocityAndPositionWindow”
else (-8) error is returned.
For a more thorough description of the Motion Done mode, please refer to the XPS
Motion Tutorial section Motion/Motion Done.
Prototype
int PositionerMotionDoneSet(
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.
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).
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.
• -17: Parameter out of range or incorrect.
403 EDH0373En1023 — 01/18