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

SVT UFF58 Get Function References VI

Owning Palette: UFF58 File I/O VIs

Installed With: Sound and Vibration Measurement Suite

Retrieves the function references and the function types of all the functions specified by function type that are present in the UFF58 (universal file format) file specified by file refnum.

Details  

file refnum specifies the UFF58 file refnum associated with the file you want to use.
function type (all functions:0) specifies the type of functions returned.
0all functions
1all time waveforms
2all spectra (real)
3all spectra (complex)
4general or unknown
5time response
6auto spectrum
7cross spectrum
8frequency response function
9transmissibility
10coherence
11auto correlation
12cross correlation
13power spectral density (PSD)
14energy spectral density (ESD)
15probability density function
16spectrum
17cumulative frequency distribution
18peaks valley
19stress/cycles
20strain/cycles
21orbit
22mode indicator function
23force pattern
24partial power
25partial coherence
26eigenvalue
27eigenvector
28shock response spectrum
29finite impulse response (FIR) filter
30multiple coherence
31order function
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnums returns the references to all the functions in the UFF58 file.
function types returns all the function types in the UFF58 file as specified by function type. A function type can have any of the following values.
0general or unknown
1time response
2auto spectrum
3cross spectrum
4frequency response function
5transmissibility
6coherence
7auto correlation
8cross correlation
9power spectral density (PSD)
10energy spectra density (ESD)
11probability density function
12spectrum
13cumulative frequency distribution
14peaks valley
15stress/cycles
16strain/cycles
17orbit
18mode indicator function
19force pattern
20partial power
21partial coherence
22eigenvalue
23eigenvector
24shock response spectrum
25finite impulse response filter
26multiple coherence
27order function
number of functions returns the total number of functions specified by function type that are in 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 Get Function References 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