Xyzsplinepulseoutputget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.395

XYZSplinePulseOutputGet

Name
XYZSplinePulseOutputGet – Gets the configuration of pulse generation of a Spline
trajectory.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks group type (must be a XYZ group): (-8)
- Checks group name: (-19)
Description
This function returns the last configuration of pulse generation of a Spline trajectory,
that was previously set by XYZSplinePulseOutputSet().
The pulse output configuration is defined by a pulse start trajectory curved length, a
pulse end trajectory curved length, and a pulse trajectory curved length interval.
Example:
XYZSplinePulseOutputSet(MyGroup, 10, 30, 0.01)
XYZSplinePulseOutputGet(MyGroup) => 0,10,30,0.01 (0 is error return, means OK)
One pulse will be generated every 10 μm on the Spline trajectory between 10 mm and
30 mm trajectory curved lengths.
Pulse start trajectory curved length = 10 mm
Pulse end trajectory curved length = 30 mm
Pulse trajectory curved length interval = 0.01 mm.
Prototype
int XYZSplinePulseOutputGet(
int SocketID,
char GroupName[250],
double * StartLength,
double * EndLength,
double * PathLengthInterval
)
Input parameters
SocketID
GroupName
Output parameters.
StartLength
EndLength
PathLengthInterval
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
double * Pulse start length (units).
double * Pulse end length (units).
double * Pulse length interval (units).
582
Programmer's Manual