Grouppositiontargetget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.100

GroupPositionTargetGet

Name
GroupPositionTargetGet – Gets the target 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 target position for one or all positioners of the selected group.
The target position represents the "end" position after the move.
For instance, during a move from 0 to 10 units, the position values are:
GroupPositionTargetGet = >10.0000
GroupPositionCurrentGet = >5.0005
GroupPositionSetpointGet = >5.0055
Prototype
int GroupPositionTargetGet(
int SocketID,
char * GroupName,
int NbPositioners,
double * TargetPosition
)
Input parameters
SocketID
GroupName
NbPositioners
Output parameters
TargetPosition
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 * Target position array.
161
Programmer's Manual
selected group.
EDH0373En1023 — 01/18