Controllerrttimeget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.5

ControllerRTTimeGet

Name
ControllerRTTimeGet – Gets the controller corrector period and corrector calculation
time.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function gets the last exact value of the controller's corrector period and the
corrector calculation time.
The default value of XPS controller corrector period is 0.125 ms (corresponding to
an 8 kHz controller corrector frequency).
Prototype
int ControllerRTTimeGet(
int SocketID,
double * CurrentRTPeriod,
double * CurrentRTUsage
)
Input parameters
SocketID
Output parameters
CurrentRTPeriod
CurrentRTUsage
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
NOTE
int Socket identifier used in each function.
double * Controller corrector period (seconds).
double * Controller corrector calculation time (seconds).
47
Programmer's Manual
EDH0373En1023 — 01/18