Newport XPS - Gatheringrun

XPS Unified Programmer’s Manual
7.2.1.50 GatheringRun
Name
GatheringRun – Starts to gather data.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Gathering must be configured: (-32)
- Gathering must not be in progress: (-43)
Description
This function starts data gathering.
Data gathering needs to be configured before using this function (See
GatheringConfigurationSet function)
The parameters are the number of data points to be gathered and the divisor of the
frequency (servo frequency) at which the data gathering will be done.
For more thorough description of the internal data gathering capability, please refer to
section Data Gathering/Internal Data Gathering of XPS Motion Tutorial.
Prototype
int GatheringRun(
int SocketID,
int DataNumber,
int Divisor
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
DataNumber int The number of data line to gather.
Divisor int The divisor of the servo frequency.
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -32: Gathering not configured.
• -43: Gathering running.
97 EDH0373En1023 — 01/18