Newport XPS - Groupspinparametersget

XPS Unified Programmer’s Manual
7.2.1.106 GroupSpinParametersGet
Name
GroupSpinParametersGet – Gets the spin profiler parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group type (must be a spindle group): (-8)
- Checks the function (must be a spindle function): (-18)
Description
This function returns the “Setpoint” (theoretical) velocity and acceleration used in SPIN
mode.
Prototype
int GroupSpinParametersGet(
int SocketID,
char * GroupName,
double * Velocity,
double * Acceleration
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Spindle group name.
Output parameters
Velocity double * Setpoint Velocity (units/s).
Acceleration double * Setpoint Acceleration (units/s²).
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.
EDH0373En1023 — 01/18 168