Positionercompensationpositionfilterset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.188

PositionerCompensationPositionFilterSet

Name
PositionerCompensationPositionFilterSet– Sets the Position filter parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the filter number: (-17)
Description
This function configures the parameters defined for selected Position filter. If the
"Frequency" value is NULL then the Position filter is not activated.
Position filters parameters:
- Frequency.
- DampingFactor.
Prototype
int PositionerCompensationPositionFilterSet(
int SocketID,
char * PositionerName,
int PositionFilterNumber,
double Frequency,
double DampingFactor
)
Input parameters
SocketID
PositionerName
PositionFilterNumber
Frequency
DampingFactor
Output parameters
None.
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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected Position. Frequency
filter.
double Frequency (Hertz) for notch filter.
double Damping factor for Position filter.
290
Programmer's Manual