Newport XPS - Positionercorrectordamperfilterget

XPS Unified Programmer’s Manual
7.2.1.206 PositionerCorrectorDamperFilterGet
Name
PositionerCorrectorDamperFilterGet – Gets Dual control loop parameters for a selected
positioner.
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 damper filter is enabled: (-205)
Description
This function allows returning the Damper Filter parameters for a PID Acceleration
control loop.
NOTE
The corrector must be “PIDFFAccelerationCorrector”.
Prototype
int PositionerCorrectorDamperFilterGet(
int SocketID,
char * PositionerName,
double
* CutOffFrequency,
double * DamperFactor,
double * Gain
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
Output parameters
CutOffFrequency double * Damper filter cut-off frequency (Hz).
DamperFactor double * Damper factor (1 by default).
Gain double * Filter gain (0 or negative value).
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.
• -205: Not enabled in your configuration.
EDH0373En1023 — 01/18 320