XPS Unified Programmer’s Manual
7.2.1.189 PositionerCompensationPostExcitationFrequencyNotchFilterGet
Name
PositionerCompensationPostExcitationFrequencyNotchFilterGet – Gets Notch
filter parameters from F3 compensation block.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks Notch Frequency number (1 to 10): (-17)
Description
This function returns the parameters defined for the selected notch filter from the post
excitation compensation (F3 compensation block) configured in the current corrector
(Option0, Option1 or Option2).
Notch filters parameters:
• NotchFrequency (Hertz).
• NotchBandwidth (Hertz).
• NotchGain.
Prototype
int PositionerCompensationPostExcitationFrequencyNotchFilterGet(
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 (1
to 10).
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.
• -17: Parameter out of range or incorrect.
291 EDH0373En1023 — 01/18
To Next Page
Loading...
Need help?
General
