Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

SVT UFF58 Read VI

Owning Palette: UFF58 File I/O VIs

Installed With: Sound and Vibration Measurement Suite

Reads data from a UFF58 (universal file format) function specified by the function refnum input. This VI also reads the fields in records 1, 2, and 3, returned by ID lines (1-3). You can read a single time domain waveform, a single frequency spectrum, the real and imaginary parts of a frequency spectrum, and any data from a function. The default instance, SVT UFF58 Read Time Waveform, reads a single time domain waveform from a function specified by the function refnum input.

Details  

Use the pull-down menu to select an instance of this VI.

SVT UFF58 Read Time Waveform

function refnum specifies the reference to a function in the UFF58 file.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
ID lines (1-3) returns the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) returns the contents of ID line 1.
ID line 2 returns the contents of ID line 2.
ID line 3 (date & time) returns the contents of ID line 3.
dup function refnum returns the same value as the function refnum input. You can wire this output to another VI. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI.
waveform returns a single time-domain signal read from the UFF58 file.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

SVT UFF58 Read Spectrum (Real)

function refnum specifies the reference to a function in the UFF58 file.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
ID lines (1-3) returns the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) returns the contents of ID line 1.
ID line 2 returns the contents of ID line 2.
ID line 3 (date & time) returns the contents of ID line 3.
dup function refnum returns the same value as the function refnum input. You can wire this output to another VI. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI.
spectrum returns a single spectrum read from the UFF58 file.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

SVT UFF58 Read Spectrum (Complex)

function refnum specifies the reference to a function in the UFF58 file.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
ID lines (1-3) returns the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) returns the contents of ID line 1.
ID line 2 returns the contents of ID line 2.
ID line 3 (date & time) returns the contents of ID line 3.
dup function refnum returns the same value as the function refnum input. You can wire this output to another VI. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI.
real part returns the real part of the spectrum.
imaginary part returns the imaginary part of the spectrum.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

SVT UFF58 Read Generic

function refnum specifies the reference to a function in the UFF58 file.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
ID lines (1-3) returns the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) returns the contents of ID line 1.
ID line 2 returns the contents of ID line 2.
ID line 3 (date & time) returns the contents of ID line 3.
dup function refnum returns the same value as the function refnum input. You can wire this output to another VI. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI.
abscissa values (X) returns the values of the coordinates on the horizontal axis.
ordinate values (Y Real) returns the real part of the spectrum.
ordinate values (Y Im) returns the imaginary part of the spectrum.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
abscissa increment (dx) returns the interval between data points in the signal.
abscissa minimum (x0) returns the initial value of coordinates on the horizontal axis.

SVT UFF58 Read Details

You cannot edit a UFF58 file with the UFF58 File I/O or UFF58 Advanced VIs after you write and close the file. If you need to edit the contents of an existing UFF58 file after you write and close the file, you can read the information then write modified information to a new UFF58 file.


Resources
 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit