Positionerpositioncomparescanaccelerationlimitget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.278

PositionerPositionCompareScanAccelerationLimitGet

Name
PositionerPositionCompareScanAccelerationLimitGet – Gets the position compare
scan acceleration limit.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the corrector type (must be PIDFFAcceleration corrector): (-24)
Description
This function returns the position compare scan acceleration limit.
During scan of position compare, the motor output will be limited to this value instead
of the AccelerationLimit.
The position compare scan acceleration limit takes effect only with PIDFFAcceleration
corrector type.
This function can be used only with a PIDFFAcceleration corrector else (-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 PositionerPositionCompareScanAccelerationLimitGet(
int SocketID,
char * FullPositionerName,
double * ScanAccelerationLimit
)
Input parameters
SocketID
FullPositionerName
Output parameters
ScanAccelerationLimit
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -17: Parameter out of range or incorrect.
• -22: Not allowed action.
• -24: Not available in this configuration (check hardware or configuration).
• -115: Function is not supported by current hardware.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Limit of position compare scan acceleration
(units/s ).
2
418
Programmer's Manual