Newport XPS Programmer's Manual

XPS Unified Programmer’s Manual
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 int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
PositionFilterNumber int Number of the selected Position. Frequency
filter.
Frequency double Frequency (Hertz) for notch filter.
DampingFactor double Damping factor for Position filter.
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.
EDH0373En1023 — 01/18 290

Newport XPS Specifications

General

Controller Type	Multi-axis motion controller
Power Supply	24 VDC
Communication Interface	Ethernet
Programming Language	C, C++, .NET, LabVIEW
Supported Motor Types	Stepper
Operating System Compatibility	Windows
Axes	Up to 8 axes