LabView API Modules¶

ziModStart¶

Creates a module. module Id allows to select following modules: sweep, zoomFFT, record, plladvisor, pidadvisor.

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.
module Id	unsigned integer (16 bit)	ID of the LabOne module to start.

Output

Name	Type	Description
Handle Out	LabOne handle out	LabOne handle out.
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.

ziModSetValue¶

This polymorphic vi sets values to module nodes specified by Path to Value.

Depending on the Value type a different VI is used automatically. The Value type can be one of the following:

string
double
complex double

Input¶

Name	Type	Description
ModHandle In	LabOne handle in	LabOne Module handle in.
Path	string	Node path
Data	dependent	Value to be set
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.

ziModExecute¶

Start the module. If the Modal is set to false, the vi waits for the module to finish and polls the data from the device. Use ziModGetNextNode.vi in order to access the available data. If the Modal is set to true, the module is started. In order to poll the data from the device use ziModRead.vi.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ziModHandle In	LabOne handle in	LabOne Module handle in.
Modal	bool	Flag if the vi blocks until the module is finished. (default = F)

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ziModHandle Out	LabOne handle out	LabOne Module handle out.

ziModSubscribe¶

Subscribes the module to a node, which will be measured as soon as the module is executed.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ModHandle In	LabOne handle in	LabOne Module handle in.
Path	string	LabOne node path.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.

ziModRead¶

ModRead polls the all data no matter if the module is finished from the device. Finished Data and partly processed data are returned and deleted from the device.

Input

Name	Type	Description
error in	error in	Error In can accept error information wired from VIs previously called.
ziModHandle In	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
error out	error out	Contains the Error information, if there are any.
ziModHandle Out	LabOne handle out	LabOne Module handle out.

ziModFinish¶

Stops a running module but does not destroy it.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ziModHandle In	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ziModHandle Out	LabOne handle out	LabOne Module handle out.

ziModGetNodeValue¶

This polymorphic vi sets values to module nodes specified by Path to Value.

Input

Name	Type	Description

Output

Name	Type	Description

ziModUnSubscribe¶

This vi is the complement to ziModSubscribe.vi and unsubsribes from a node.

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 = "/")
ModHandle In	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.

ziModStatus¶

This vi gives the status of the Module run and returns a finished flag when the module has finished.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ModHandle IN	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.
Finished?	bool	Flag if the module finished.
Progress	double	Progress out (continuously updated).

ziModGetNextNode¶

Use this device to extract the data from subscribed node, which you polled from device by ziModExecute.vi (with modal is false) or the ziModRead.vi. This allows to iterate through ModResults and return the Path, the ValueType and the NoOfResults. If this iterator, does not find any more data, the NoData flag is raised.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ModHandle In	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.
ModResults	LabOne handle out	LabOne Module result.
NoData	bool	Flag if no data is available.

ziModClear¶

Destroys a module.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ziModHandle In	LabOne handle in	LabOne Module handle in.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.

ziModExecuteTimeout¶

Start the module. If the Modal is set to false, the vi waits for the module to finish and polls the data from the device. Use ziModGetNextNode.vi in order to access the available data. If the Modal is set to true, the module is started. In order to poll the data from the device use ziModRead.vi.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ziModHandle In	LabOne handle in	LabOne Module handle in.
Modal	bool	Flag if the vi blocks until the module is finished. (default = F)
Timeout 5000ms	unsigned integer (32 bit)	TODO

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ziModHandle Out	LabOne handle out	LabOne Module handle out.
Finished?	bool	Flag if the module finished.

ziModGetData¶

This vi retrieves the value of the specified node. The vi returns the value first found that matches path if more than one value is available (a wildcard is used in the Path).

Depending on the value in the dropdown menu, different VI are used.

Input¶

Name	Type	Description
ziModHandle In	LabOne handle in	LabOne Module handle in.
Path	string	Node path
Error In	error in	Error In can accept error information wired from VIs previously called.

Output¶

Name	Type	Description
ziModHandle Out	LabOne handle out	LabOne Module handle out.
Value	dependent	Value from the requested node
Error Out	error out	Contains the Error information, if there are any.

ziModGetGenericHeader¶

Use this vi to get Double Data from a ModResult returned from ziModGetNextNode.vi. It returns an array of Double Data.

Input

Name	Type	Description
Error In	error in	Error In can accept error information wired from VIs previously called.
ModHandle In	LabOne handle in	LabOne Module handle in.
ModResults	LabOne handle in	LabOne Module result.

Output

Name	Type	Description
Error Out	error out	Contains the Error information, if there are any.
ModHandle Out	LabOne handle out	LabOne Module handle out.
ModResults	LabOne handle out	LabOne Module result.