Positionercompensationprefeedforwardspatialnotchfilterget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.201

PositionerCompensationPreFeedForwardSpatialNotchFilterGet

Name
PositionerCompensationPreFeedForwardSpatialNotchFilterGet – Gets the spatial
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 spatial notch number: (-17)
- Checks the positioner name: (-18)
Description
This function returns the parameters defined for the selected spatial notch filter.
Spatial notch filters parameters:
• SpatialNotchStep.
• SpatialNotchBandwidth.
• SpatialNotchGain.
Prototype
int PositionerCompensationPreFeedForwardSpatialNotchFilterGet(
int SocketID,
char * PositionerName,
int SpatialNotchNumber,
double * SpatialNotchStep,
double * SpatialNotchBandwidth,
double * SpatialNotchGain
)
Input parameters
SocketID
PositionerName
SpatialNotchNumber
Output parameters
SpatialNotchStep
SpatialNotchBandwidth
SpatialNotchGain
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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected Spatial Notch Frequency
filter.
double * Step for spatial notch filter.
double * Band width (Hertz) for spatial notch filter.
double * Gain for spatial notch filter.
311
Programmer's Manual
EDH0373En1023 — 01/18