Groupanalogtrackingmodeenable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.70

GroupAnalogTrackingModeEnable

Name
GroupAnalogTrackingModeEnable - Enables the analog tracking mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids tracking type ("Position" or "Velocity"): (-8)
- Valids group name: (-19)
- Group status must be "READY": (-22)
- Configured tracking: (-22)
Description
Enables the analog tracking mode. To use this function, the group must be in READY
state and tracking must be configured before, otherwise an error (-22) is returned.
Once the tracking mode is enabled, the group status must be "ANALOG TRACKING"
(48 is the code for Analog tracking state due to a TrackingEnable command).
"Position" analog tracking
In case of "Position" tracking type, the analog input is interpreted as a position
command. The parameters must be set by "AnalogTrackingPositionParametersSet"
function and can be read by "AnalogTrackingPositionParametersGet" function.
"Velocity" analog tracking
In case of "Velocity" tracking type, the analog input is interpreted as a velocity
command. The parameters must be set by "AnalogTrackingVelocityParametersSet"
function and can be read by "AnalogTrackingVelocityParametersGet" function.
To disable the analog tracking mode use "GroupAnalogTrackingModeDisable"
function.
Prototype
int GroupAnalogTrackingModeEnable(
int SocketID,
char * GroupName,
char * Type
)
Input parameters
SocketID
GroupName
Type
Output parameters
None.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
char * Tracking type ("Position" or
117
Programmer's Manual
"Velocity").
EDH0373En1023 — 01/18