Newport XPS - Positionerdriverfiltersget

XPS Unified Programmer’s Manual
7.2.1.233 PositionerDriverFiltersGet
Name
PositionerDriverFiltersGet – Gets the piezo driver notch and low-pass filters
parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner type: (-8)
- Checks driver type, if not PIEZO: (-24)
- If piezo driver, check if driver is not initialized: (-118)
Description
This function returns current values of the piezo driver filters parameters (KI, notch
frequency, notch bandwidth, notch gain, low-pass frequency).
Prototype
int PositionerDriverFiltersGet(
int SocketID,
char * FullPositionerName,
double * KI,
double * NotchFrequency,
double * NotchBandwidth,
double * NotchGain,
double * LowpassFrequency
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
KI double * Driver KI.
NotchFrequency double * Driver notch frequency (Hz).
NotchBandwidth double * Driver notch bandwidth (Hz).
NotchGain double * Driver notch gain.
LowpassFrequency double * Driver low-pass frequency (Hz).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -24: Not available in this configuration (check hardware or configuration).
• -118: Not allowed action driver not initialized.
363 EDH0373En1023 — 01/18