Positionercurrentvelocityaccelerationfiltersget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.231

PositionerCurrentVelocityAccelerationFiltersGet

Name
PositionerCurrentVelocityAccelerationFiltersGet – Gets the velocity and
acceleration filter cut-off frequencies.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type: (-8)
Description
This function returns the current velocity cut-off frequency and the current acceleration
cut-off frequency used by gathering for the selected positioner.
Gathering uses these parameters to filter the current velocity and the current
acceleration. These parameters are defined in the stages.ini file.
Prototype
int PositionerCurrentVelocityAccelerationFiltersGet(
int SocketID,
char * FullPositionerName,
double * VelocityCutOffFrequency,
double * AccelerationCutOffFrequency
)
Input parameters
SocketID
FullPositionerName
Output parameters
VelocityCutOffFrequency
AccelerationCutOffFrequency double * Acceleration 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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Velocity filter cut-off frequency (Hz).
360
Programmer's Manual