Newport XPS - Positionercompensationdualloopnotchfilterget

XPS Unified Programmer’s Manual
7.2.1.169 PositionerCompensationDualLoopNotchFilterGet
Name
PositionerCompensationDualLoopNotchFilterGet – Gets the notch filter parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the object type of this command is valid: (-8)
- Checks the notch filter number: (-17)
- Checks the positioner name: (-18)
- Checks dual corrector is enabled: (-205)
Description
This function returns the parameters defined for the selected notch filter in dual loop.
Notch filters parameters:
• NotchFrequency.
• NotchBandwidth.
• NotchGain.
Prototype
int PositionerCompensationDualLoopNotchFilterGet(
int SocketID,
char * PositionerName,
int NotchFrequencyNumber,
double * NotchFrequency,
double * NotchBandwith,
double * NotchGain
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
NotchFrequencyNumber int Number of the selected Notch Frequency filter.
Output parameters
NotchFrequency double * Frequency (Hertz) for notch filter.
NotchBandwith double * Band width (Hertz) for notch filter.
NotchGain double * Gain for notch filter.
EDH0373En1023 — 01/18 256