Positionercompensationpostexcitationnotchmodefilterget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.193

PositionerCompensationPostExcitationNotchModeFilterGet

Name
PositionerCompensationPostExcitationNotchModeFilterGet – Gets the notch mode
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 functions returns the system compensation parameters defined for two notch mode
filters.
Notch mode filter parameters:
• NotchModeFr: Resonance frequency (Hertz)
• NotchModeFa: Anti-resonance frequency (Hertz)
• NotchModeZr: Resonance damping factor.
• NotchModeZa: Anti-resonance damping factor.
Prototype
int PositionerCompensationPostExcitationNotchModeFilterGet(
int SocketID,
char * PositionerName,
int NotchModeNumber,
double * NotchModeFr,
double * NotchModeFa,
double * NotchModeZr,
double * NotchModeZa
)
Input parameters
SocketID
PositionerName
NotchModeNumber
Output parameters
NotchModeFr
NotchModeFa
NotchModeZr
NotchModeZa
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected notch mode filter.
double * Resonance frequency (Hertz) for notch mode
filter.
double * Anti-resonance frequency (Hertz) for notch
mode filter.
double * Resonance damping factor for notch mode filter.
double * Anti-resonance damping factor for notch mode
filter.
296
Programmer's Manual