Newport XPS-D - Xyptpulseoutputget

XPS Unified Programmer’s Manual
7.2.1.378 XYPTPulseOutputGet
Name
XYPTPulseOutputGet – Gets the configuration of pulse generation of a PT trajectory.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks group type (must be a XY group): (-8)
- Checks group name: (-19)
- Not available in this configuration (PrecisionPlatform firmware only): (-24)
Description
This function returns the last configuration of pulse generation of a PT trajectory, that
was previously set by XYPTPulseOutputSet().
The pulse output configuration is defined with a start element, an end element, and a
time interval in seconds.
Example:
XYPTPulseOutputSet(MyGroup, 3, 5, 0.01)
XYPTPulseOutputGet(MyGroup) => 0,3,5,0.01 (0 is error return, means OK)
One pulse will be generated every 10 ms between the start of the 3rd element and the
end of the 5th element.
Start element= 3
End element = 5
Time interval = 0.01 seconds.
Prototype
int XYPTPulseOutputGet(
int SocketID,
char GroupName[250],
int * StartElement,
int * EndElement,
double * TimeInterval
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
Output parameters
StartElement int * Start pulse element number.
EndElement int * End pulse element number.
TimeInterval double * Time interval between pulses (seconds).
EDH0373En1023 — 01/18 552