LabVIEW API Data¶
ziSubscribe¶
Subscribes to nodes so that whenever the value of the node changes the new value can be polled using ziPollDataEx.vi. By using wildcards or by using a Path that is not a leaf node but contains sub nodes, more than one node can be subscribed to with one function call.
Input
| Name | Type | Description |
|---|---|---|
| error in |  error in |
Error In can accept error information wired from VIs previously called. |
| Path |  string |
LabOne node path. |
| Handle In |  LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| error out |  error out |
Contains the Error information, if there are any. |
| Handle Out |  LabOne handle out |
LabOne handle out. |
ziUnSubscribe¶
This vi is the complement to ziSubscribe.vi. By using wildcards or by using a Path that is not a leaf node but contains sub nodes, more than one node can be unsubscribed with one vi call.
Input
| Name | Type | Description |
|---|---|---|
| error in | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. (default = "/") |
| Handle in | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| error out | error out |
Contains the Error information, if there are any. |
| Handle out | LabOne handle out |
LabOne handle out. |
ziGetValueAsPoll¶
Use this vi to receive the value of one or more nodes as events using ziPollDataEx, even when the node is not subscribed or no value change has occurred.
Input
| Name | Type | Description |
|---|---|---|
| Handle in | LabOne handle in |
LabOne handle in. |
| error in | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. |
Output
| Name | Type | Description |
|---|---|---|
| Handle out | LabOne handle out |
LabOne handle out. |
| error out | error out |
Contains the Error information, if there are any. |
ziPollDataEx¶
Use this vi to receive all value changes that occur in nodes that have been subscribed to, or in children of nodes that have been subscribed to. This vi returns immediately if data is pending. Otherwise it waits for data for up to Timeout milliseconds before it returns with Timed Out true. When no data event was received within TimeOut milliseconds, ziValueType will be NONE and the Timed Out will be true.
Input
| Name | Type | Description |
|---|---|---|
| error in | error in |
Error In can accept error information wired from VIs previously called. |
| Timeout ms |  integer (32 bit) |
Timeout if no data updates are received. (default = 50) |
| Handle In | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| error out | error out |
Contains the Error information, if there are any. |
| ziValueType |  integer (enumerated) |
Value Type |
| Timed Out |  bool |
Flag if the command timed out. |
| Handle Out | LabOne handle out |
LabOne handle out. |
| PathArray |  string array |
Array of the paths for the received value updates |
| Value Double |  double |
|
| Value Int |  integer (32 bit) |
|
| Timestamp |  unsigned integer (64 bit) |
Timestamp of the event. |
ziPollDataExDemodTime¶
This vi polls Demod data from a previously subscriped demod path for a given recording time.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| error in | error in |
Error In can accept error information wired from VIs previously called. |
| recording time |  double |
Defines the recording time of the poll. (default = 1) [s) |
| SubscribepathArray |  string array |
Subscribed demod paths. |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| error out | error out |
Contains the Error information, if there are any. |
| Demod Sample Out |  string array |
Received demodulator sample. |
ziGetEvent¶
This vi retrieves data from a previous ziPollDataEx.vi call. Use the Path and ziValueType returned by ziPollDataEx.vi to determine, which polymorphic version of ziGetEvent.vi is appropriate.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| Sample In | sample |
input |
| error in | error in |
Error In can accept error information wired from VIs previously called. |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| Sample Out | sample |
input |
| error out | error out |
Contains the Error information, if there are any. |
ziSync¶
Syncs all the settings on the device and flushes all buffers.
Input
| Name | Type | Description |
|---|---|---|
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Handle In | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Handle Out | LabOne handle out |
LabOne handle out. |
ziFlush¶
Flush all data that currently is either in the server fifos or API fifos.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| error in | error in |
Error In can accept error information wired from VIs previously called. |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| error out | error out |
Contains the Error information, if there are any. |