Xyzsplineverification - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.397

XYZSplineVerification

Name
XYZSplineVerification – Checks a Spline trajectory data file.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks trajectory file name length (must ≤250): (-3)
- Checks group type (must be a XYZ group): (-8)
- Checks group name: (-19)
- Checks trajectory file existence and the file format: (-61)
- Checks trajectory (number of elements must >0): (-66)
Description
This function verifies the execution of a Spline trajectory. The results of the verification
can be got with the "XYZSplineVerificationResultGet" function. The trajectory file
must be stored in the folder "\ADMIN\Public\Trajectory" of the XPS controller. If the
trajectory cannot be initialized (task error) then the (-72) error is returned.
This function can be executed at any time and is independent of the trajectory
execution. It performs the following:
• Checks the trajectory file for data coherence.
• Calculates the trajectory limits, which are: the required travel per positioner, the
maximum possible trajectory velocity and the maximum possible trajectory
acceleration. This function helps define the parameters for the trajectory execution.
• The required travel values (MinimumPosition and MaximumPosition) are calculated
relative to the position zero, not to the current position. So before executing a Spline
trajectory, the user must pay attention to the current position of the positioners to
make sure that the trajectory will not exceed the positioner travel limits.
• If all is OK, it returns "SUCCESS" (0). Otherwise, it returns a corresponding error.
The "XYZSplineVerification" function is independent from the
"XYZSplineExecution" function, but it is highly recommended to execute this
function before executing a Spline trajectory.
Prototype
int XYZSplineVerification(
int SocketID,
char GroupName[250],
char FileName[250]
)
Input parameters
SocketID
GroupName
FileName
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
char * Trajectory file name.
586
Programmer's Manual