Newport XPS-D - Groupgantrymodeset

XPS Unified Programmer’s Manual
7.2.1.76 GroupGantryModeSet
Name
GroupGantryModeSet – Sets gantry option.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the user option value (Option0, Option1 or Option2): (-17)
- Checks the group name (must be XY group): (-19)
- Checks if the gantry mode getting is allowed: (-22)
- Checks the current gantry option: (-201)
- Checks if XY Dual Gantry mode is enabled: (-205)
Description
Sets the gantry option. It’s possible to configure the gantry option only when the XY
group is in “READY” or “DISABLE” state.
Three “Gantry” options are available:
• Option0 = >Gantry standard.
• Option1 = >Gantry force balance.
• Option2 = >Gantry force balance with dual encoder.
Refer to XY group section from system.ini file to enable “XYDualMode” and to
configure it.
Prototype
int GroupGantryModeSet(
int SocketID,
char * GroupName,
char * Option
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * XY group name.
Option char * Option0, Option1 or Option2.
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -17: Parameter out of range or incorrect.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
• -201: The group is already in this mode.
• -205: Not enable in your configuration.
EDH0373En1023 — 01/18 124