Newport XPS - Positionercompensationpositionfilterget

XPS Unified Programmer’s Manual
7.2.1.187 PositionerCompensationPositionFilterGet
Name
PositionerCompensationPositionFilterGet – Gets the Position filter parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the filter number: (-17)
Description
This function returns the parameters defined for the selected position filter.
Position filters parameters:
- Frequency.
- DampingFactor.
Prototype
int PositionerCompensationPositionFilterGet(
int SocketID,
char * PositionerName,
int PositionFilterNumber,
double * Frequency,
double * DampingFactor
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
PositionFilterNumber int Number of the selected Position. Frequency
filter.
Output parameters
Frequency double * Frequency (Hertz) for notch filter.
DampingFactor double * Damping factor for Position filter.
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.
289 EDH0373En1023 — 01/18