Positionercorrectorpipositionget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.224

PositionerCorrectorPIPositionGet

Name
PositionerCorrectorPIPositionGet – Gets PIPosition corrector parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type and the corrector type: (-8)
Description
This function returns the corrector parameter values used by a PI with a position output:
ClosedLoopStatus, KP, KI and IntegrationTime.
The "CorrectorType" must be "PIPosition" in the stages.ini file. This servo loop
type is used when the position servo loop outputs a position value directly.
Prototype
int PositionerCorrectorPIPositionGet(
int SocketID,
char * FullPositionerName,
bool * ClosedLoopStatus,
double * KP,
double * KI,
double * IntegrationTime
)
Input parameters
SocketID
FullPositionerName
Output parameters
ClosedLoopStatus
KP
KI
IntegrationTime
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
bool * Position servo loop status (true = closed and
false = opened).
double * PI servo loop proportional gain.
double * PI servo loop integral gain.
double * PI integration time (seconds).
352
Programmer's Manual