Gatheringconfigurationset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.39

GatheringConfigurationSet

Name
GatheringConfigurationSet – Sets a data gathering action.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks input gathering mnemonic: (-29)
- Gathering must not be in progress: (-43)
Description
Defines one or several types of data gathered during the internal triggered data
gathering.
Maximum of 1000000 points can be acquired.
Maximum of 25 data types can be configured in a gathering.
Refer to section 8.3: "Gathering Data Types".
The "GatheringListGet" function can be used to retrieve a complete list of gathering
types.
For a more thorough description of the internal data gathering capability, please refer to
section Data Gathering/Internal Data Gathering of XPS Motion Tutorial.
Prototype
int GatheringConfigurationSet(
int SocketID,
int NbElements,
char * TypeArray
)
Input parameters
SocketID
NbElements
TypeArray
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -29: Mnemonic gathering type doesn't exist.
• -32: Gathering not configured.
• -43: Gathering running.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int Number of types.
char * Array of configured gathering types.
85
Programmer's Manual
EDH0373En1023 — 01/18