Newport XPS-D - Positionercompensationnotchfilterget

XPS Unified Programmer’s Manual
7.2.1.179 PositionerCompensationNotchFilterGet
Name
PositionerCompensationNotchFilterGet – 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 phase correction number: (-17)
- Checks the positioner name: (-18)
Description
This function returns the parameters defined for the selected notch filter.
Notch filters parameters:
- NotchFrequency.
- NotchBandwidth.
- NotchGain.
Prototype
int PositionerCompensationNotchFilterGet(
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.
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.
• -18: Positioner Name doesn't exist or unknown command.
• -205: Not enable in your configuration.
EDH0373En1023 — 01/18 274