Newport XPS-D - Groupmoveabortfast

XPS Unified Programmer’s Manual
7.2.1.94 GroupMoveAbortFast
Name
GroupMoveAbortFast – aborts with user-defined deceleration a motion or a jog in
progress for a group or positioner.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Valids object type (group or positioner): (-8)
- Valids UserDecelerationMultiplier value (≥1 and ≤100): (-17)
- Valids positioner name: (-18)
- Valids group name: (-19)
- Group status must be "MOVING” or “JOGGING”: (-22)
Description
This function aborts a motion or a jog in progress with a deceleration value defined by
user (UserDeceleration):
UserDeceleration = DecelerationMultiplier * MaximumAcceleration.
Here: DecelerationMultiplier: GroupMoveAbortFast function parameter
MaximumAcceleration: Stage parameter, defined in the stages.ini file.
The group state must be “MOVING” or “JOGGING”, otherqise error (-22) is returned.
For a group:
If the group state is “MOVING”, this function stops all motion.
If the group state is “JOGGING”, this function stops all “jog” motion and disables the
jog mode. After this “group move abort” action, the group state becomes “READY”.
For a positioner:
If the group state is “MOVING”, this function stops the motion of the selected
positioner.
If the group state is “JOGGING”, this function stops the “jog” motion of the selected
positioner.
If the positioner is idle, error (-22) is returned.
After “positioner move abort” action, if all positioners are idle, the group state becomes
“READY”, otherwise it stays the same
NOTE
If the “move abort” action fails, error (-27) is returned.
Prototype
int GroupMoveAbortFast(
int SocketID,
char * GroupName
)
EDH0373En1023 — 01/18 152