Grouppositionsetpointget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.99

GroupPositionSetpointGet

Name
GroupPositionSetpointGet – Gets the setpoint position for one or all positioners of the
selected group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids object type (group or positioner): (-8)
- Valids positioner name: (-18)
- Valids group name: (-19)
Description
Returns the setpoint position for one or all positioners of the selected group.
The "setpoint" position is calculated by the motion profiler and represents the
"theoretical" position to reach.
Prototype
int GroupPositionSetpointGet(
int SocketID,
char * GroupName,
int NbPositioners,
double * SetpointPosition
)
Input parameters
SocketID
GroupName
NbPositioners
Output parameters
SetpointPosition
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -19: GroupName doesn't exist or unknown command.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
int Number of positioners in the
double * Setpoint position array.
160
Programmer's Manual
selected group.