Singleaxisslaveparametersset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.304

SingleAxisSlaveParametersSet

Name
SingleAxisSlaveParametersSet – Sets the slave parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the master group type: (-8)
- Checks the ratio value (Ratio >0): (-17)
- Checks the master positioner name: (-18)
- Checks the slave parameters (must be configured): (-22)
- Checks the base velocity value (must be null): (-48)
Description
This function configures the slave parameters only for a SingleAxis group.
The slave is a copy of the master and a ratio can be applied: Slave = Ratio * Master.
The slave-master mode is activated only after the call of "SingleAxisSlaveModeEnable"
function.
The master can be a positioner from any group, except from a spindle group. If the
master group is a spindle then (-22) error is returned. The master positioner must be
different from the slave positioner else (-8) error is returned.
After an emergency stop, the master group and the slave group are in "NOTINIT"
status. To restart a master-slave relation, the slave group(s) must be reinitialized
before the master group.
Prototype
int SingleAxisSlaveParametersSet(
int SocketID,
char * GroupName,
int NbPositioners,
char * MasterPositionerName ,
double Ratio
)
Input parameters
SocketID
GroupName
MasterPositionerName
Ratio
Output parameters
None.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * SingleAxis group name.
char * Master positioner name from
double Gear ratio between the master and the slave.
448
Programmer's Manual
any group.