Newport XPS-D - Positionercorrectorpidaccelerationfilterget

XPS Unified Programmer’s Manual
7.2.1.214 PositionerCorrectorPIDAccelerationFilterGet
Name
PositionerCorrectorPIDAccelerationFilterGet – Gets PID acceleration corrector
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)
Description
This function returns PID acceleration corrector filter parameters.
Prototype
int PositionerCorrectorPIDAccelerationFilterGet(
int SocketID,
char * PositionerName,
bool * FilterControlStatus,
double * KD,
double * DerivativeFilterCutOffFrequency
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
Output parameters
FilterControlStatus bool * Current position of X axis.
KD double * KD gain.
DerivativeFilterCutOffFrequency double * Derivative Filter Cut-off Frequency
(Hz).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
333 EDH0373En1023 — 01/18