Positionersgammaexactvelocityajusteddisplacementget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.284

PositionerSGammaExactVelocityAjustedDisplacementGet

Name
PositionerSGammaExactVelocityAjustedDisplacementGet – Gets the adjusted
displacement to get exact velocity.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the profiler type (must be "SGamma"): (-8)
- Checks the positioner type (must not be a secondary positioner): (-8)
Description
This function returns the closest optimum displacement to obtain the most precise
velocity during the displacement.
Prototype
int PositionerSGammaExactVelocityAjustedDisplacementGet(
int SocketID,
char * FullPositionerName
double DesiredDisplacement,
double * AdjustedDisplacement
)
Input parameters
SocketID
FullPositionerName
DesiredDisplacement
Output parameters
AdjustedDisplacement
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double Desired displacement (units).
double * Ajusted displacement (units).
426
Programmer's Manual