Killall - Newport XPS Programmer's Manual

XPS Unified
7.2.1.118

KillAll

Name
KillAll – Kills all groups.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function kills and resets all groups as well as all analog and digital I/O's
The following sequence of steps is performed by KillAll function.
1) An "emergency stop" is exectuted if the group state is defined as:
HOMING
REFERENCING
MOVING
JOGGING
ANALOG_TRACKING
2) The motor is turned off, the motion done is stopped and the control loop is stopped.
3) "ERR_EMERGENCY_SIGNAL" is returned by each function in progress, and for
groups that are in following states:
MOTOR_INIT
ENCODER_CALIBRATING
HOMING
REFERENCING
MOVING
TRAJECTORY
ERR_EMERGENCY_SIGNAL
4) the group state is not initialized "NOTINIT" for all groups.
Prototype
int KillAll(
int SocketID
)
Input parameters
SocketID
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
181
Programmer's Manual
EDH0373En1023 — 01/18