Positionerpositioncomparescanaccelerationlimitset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.279

PositionerPositionCompareScanAccelerationLimitSet

Name
PositionerPositionCompareScanAccelerationLimitSet – Sets the position compare
acceleration limit.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks input parameter values: (-17)
• PositionCompareScanAccelerationLimit value must >0 and
≤MaximumAcceleration (value in stages.ini)
- Checks the corrector type (must be PIDFFAcceleration corrector): (-24)
Description
This function sets the position compare scan acceleration limit.
During position compare, the motor output will be limited to this value instead of
AccelerationLimit.
The position compare scan acceleration limit takes effect only with PIDFFAcceleration
corrector type.
This function can be used only with a PIDFFAcceleration corrector otherwise the (-24)
error is returned.
For a more thorough description of the position compare output, please refer to the XPS
Motion Tutorial section Triggers/Position Compare Output.
Prototype
int PositionerPositionCompareScanAccelerationLimitSet(
int SocketID,
char * FullPositionerName,
double * ScanAccelerationLimit
)
Input parameters
SocketID
FullPositionerName
ScanAccelerationLimit
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.
• -24: Not available in this configuration (check hardware or configuration).
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double Limit of position compare scan acceleration
(units/s ).
2
419
Programmer's Manual
EDH0373En1023 — 01/18