Positionercompensationpostexcitationlowpassfilterset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.192

PositionerCompensationPostExcitationLowPassFilterSet

Name
PositionerCompensationPostExcitationLowPassFilterSet – Sets second order low-
pass 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 input parameters value: (-17)
• CutOffFrequency with CorrectorPeriod = 0.0001 s (10 kHz) = >
- Checks the positioner name: (-18)
- Checks compensation post excitation mode is enabled: (-24)
- Checks the motion status (Motion status must be disable): (-134)
Description
This function configures the parameters defined for the second order low-pass filter. If
the "CutOffFrequency" value = 0 then the second order low-pass filter is not activated.
Prototype
int PositionerCompensationPostExcitationLowPassFilterSet(
int SocketID,
char * PositionerName,
double CutOffFrequency
)
Input parameters
SocketID
PositionerName
CutOffFrequency
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.
• -18: Positioner Name doesn't exist or unknown command.
• -24: Not available in this configuration (check hardware or configuration).
• -134: Changing the loop status is allowed in DISABLE state only.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double Second order filter cut-off frequency (Hertz).
295
Programmer's Manual
[ ]
0 : 5000
EDH0373En1023 — 01/18