Newport XPS-D - Singleaxisslaveparametersget

XPS Unified Programmer’s Manual
7.2.1.303 SingleAxisSlaveParametersGet
Name
SingleAxisSlaveParametersGet – Gets the slave parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group type (must be a SingleAxis group): (-8)
- Checks the positioner name: (-18)
- Checks the slave parameters (must be configured): (-22)
Description
This function returns the slave parameters: the master positioner name and the master-
slave ratio.
Prototype
int SingleAxisSlaveParametersGet(
int SocketID,
char * GroupName,
int NbPositioners,
char * MasterPositionerName ,
double * Ratio
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * SingleAxis group name.
Output parameters
MasterPositionerName char * Master positioner name from any group.
Ratio double * Gear ratio between the master and the slave.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
447 EDH0373En1023 — 01/18