Positionercorrectortypeget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.230

PositionerCorrectorTypeGet

Name
PositionerCorrectorTypeGet – Gets the corrector type.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type: (-8)
Description
This function returns the corrector type used by the selected positioner.
The corrector type can be one of this list:
• PositionerCorrectorPIDFFAcceleration.
• PositionerCorrectorPIDFFVelocity.
• PositionerCorrectorPIDDualFFVoltage.
• PositionerCorrectorPIPosition.
• NoCorrector.
The corrector type is defined in the stages.ini file with the "CorrectorType"
parameter.
Prototype
int PositionerCorrectorTypeGet(
int SocketID,
char * FullPositionerName,
char * CorrectorType
)
Input parameters
SocketID
FullPositionerName
Output parameters
CorrectorType
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.
char * Corrector type.
359
Programmer's Manual
EDH0373En1023 — 01/18