Groupspinparametersset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.107

GroupSpinParametersSet

Name
GroupSpinParametersSet – Sets 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 input parameter value: (-17)
• Velocity ≤MaximumVelocity.
• Velocity ≥- MaximumVelocity.
• Acceleration >0.
• Acceleration ≤MaximumAcceleration.
- Checks the function (must be a spindle function): (-18)
Description
This function starts the SPIN mode and allows on-the-fly changes to the velocity and
acceleration used by this mode. If an error occurs, the positioner stops and the velocity
value is set to zero.
After the tests on input values:
If Velocity >MaximumVelocity = >Velocity = MaximumVelocity
If Velocity <- MaximumVelocity = >Velocity = - MaximumVelocity
If Acceleration ≤0 = >ERROR and stop motion
If Acceleration >MaximumAcceleration = >Acceleration = MaximumAcc.
Prototype
int GroupSpinParametersSet(
int SocketID,
char * GroupName,
double Velocity,
double Acceleration
)
Input parameters
SocketID
GroupName
Velocity
Acceleration
Output parameters
None.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Spindle group name.
double Setpoint Velocity (units/s).
double Setpoint Acceleration (units/s²).
169
Programmer's Manual
EDH0373En1023 — 01/18