Xyzsplineparametersget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.394

XYZSplineParametersGet

Name
XYZSplineParametersGet – Gets Spline trajectory parameters.
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)
- Checks current executing trajectory type (must be Spline): (-22)
Description
This function returns the Spline trajectory parameters (trajectory name, trajectory
velocity, trajectory acceleration, current executing element number) of the current
Spline trajectory.
Prototype
int XYZSplineParametersGet(
int SocketID,
char GroupName[250],
char * FileName,
double * Velocity,
double * Acceleration,
int * CurrentElementNumber
)
Input parameters
SocketID
GroupName
Output parameters
FileName
Velocity
Acceleration
CurrentElementNumber
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -19: Group name doesn't exist or unknown command.
• -22: Not allowed action.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
char * Currently executing trajectory file name.
double * Trajectory velocity (units/s).
double * Trajectory acceleration (units/s²).
int * Currently executing element number.
581
Programmer's Manual
EDH0373En1023 — 01/18