TDM Streaming VIs and Functions

LabVIEW 2018 Help

Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)

	LabVIEW 2016 Help
	LabVIEW 2017 Help
	LabVIEW 2018 Help
	LabVIEW 2019 Help
	LabVIEW 2020 Help

Owning Palette: File I/O VIs and Functions

Requires: Base Development System. This topic might not match its corresponding palette in LabVIEW depending on your operating system, licensed product(s), and target.

Use the TDM Streaming VIs and functions to read and write waveforms and waveform properties to binary measurement files (.tdms).

Some functions on this palette do not work with real-time operating systems.

The VIs and functions on this palette can return TDM streaming error codes.

Palette Object	Description
TDMS Close	Copyright: (c) 2018 National Instruments. All rights reserved. Closes the .tdms file you opened with the TDMS Open function.
TDMS Defragment	Copyright: (c) 2018 National Instruments. All rights reserved. Defragments the .tdms file data specified in the file path input. Use this function to clean up your .tdms data when it becomes cluttered, and increase performance.
TDMS File Viewer	Copyright: (c) 2018 National Instruments. All rights reserved. Opens the .tdms file specified in the file path input and presents the file data in the TDMS File Viewer dialog box.
TDMS Flush	Copyright: (c) 2018 National Instruments. All rights reserved. Writes all buffers of the .tdms file data to the file identified by the tdms file input. Data written to a .tdms file often resides in a buffer until the buffer fills up or until you close the file. This function forces the operating system to write any buffer data to the .tdms file.
TDMS Get Properties	Copyright: (c) 2018 National Instruments. All rights reserved. Returns the properties of the specified .tdms file, channel group, or channel. If you wire the group name and channel name inputs with values, the function searches for properties at the channel level. Wiring only the group name input with a value searches for properties at the channel group level. If both group name and channel name inputs contain no values, the function searches for properties at the root level of the .tdms file. If you wire the channel name input with a value, you must also wire a value to the group name input.
TDMS List Contents	Copyright: (c) 2018 National Instruments. All rights reserved. Provides a list of group and channel names contained within the .tdms file specified in the .tdms file input.
TDMS Open	Copyright: (c) 2018 National Instruments. All rights reserved. Opens a .tdms file for reading or writing. You also can use this function to create a new file or replace an existing file. Use the TDMS Close function to close the reference to the file.
TDMS Read	Copyright: (c) 2018 National Instruments. All rights reserved. Reads the specified .tdms file and returns data in a format specified by the data type input. If data has scaling information, this VI automatically scales the data. Use the count and offset inputs to read a specified subset of the data.
TDMS Set Properties	Copyright: (c) 2018 National Instruments. All rights reserved. Sets the properties of the specified .tdms file, channel group, or channel. If you wire the group name and channel name inputs with values, the function writes the properties at the channel level. Wiring only the group name input with a value writes the properties at the channel group level. If both group name and channel name inputs contain no values, the properties become file-specific. If you wire the channel name input with a value, you must also wire a value to the group name input. You must close the reference to the .tdms file or flush data to the .tdms file for changes to take effect.
TDMS Write	Copyright: (c) 2018 National Instruments. All rights reserved. Streams data to the specified .tdms file. The data subset to write is determined by the values you identify in the group name in and channel name(s) in inputs.

Subpalette	Description
Advanced TDMS VIs and Functions	Copyright: (c) 2018 National Instruments. All rights reserved. Use the Advanced TDMS VIs and functions to perform advanced file I/O operations, such as asynchronous reads and writes, on .tdms files. You can use these VIs and functions to read data from an existing .tdms file, write data to a new .tdms file, or replace subsets of data in an existing .tdms file. You also can use these VIs and functions to convert the file format version of a .tdms file or to create scaling information for unscaled data.

Subpalette

Description

Advanced TDMS VIs and Functions

Copyright: (c) 2018 National Instruments. All rights reserved.

Use the Advanced TDMS VIs and functions to perform advanced file I/O operations, such as asynchronous reads and writes, on .tdms files. You can use these VIs and functions to read data from an existing .tdms file, write data to a new .tdms file, or replace subsets of data in an existing .tdms file. You also can use these VIs and functions to convert the file format version of a .tdms file or to create scaling information for unscaled data.

Unsupported Functions on Real-Time Operating Systems

The following functions on this palette do not work with real-time operating systems, such as Phar Lap ETS, VxWorks, and NI Linux Real-Time:

TDMS Advanced Asynchronous Read
TDMS Advanced Asynchronous Read (Data Ref)
TDMS Advanced Asynchronous Write
TDMS Advanced Asynchronous Write (Data Ref)
TDMS Configure Asynchronous Reads
TDMS Configure Asynchronous Reads (Data Ref)
TDMS Configure Asynchronous Writes
TDMS Configure Asynchronous Writes (Data Ref)
TDMS File Viewer
TDMS Generate Random Data
TDMS Get Asynchronous Read Status
TDMS Get Asynchronous Read Status (Data Ref)
TDMS Get Asynchronous Write Status
TDMS Get Asynchronous Write Status (Data Ref)
TDMS Reserve File Size
TDMS Start Asynchronous Reads
TDMS Stop Asynchronous Reads

WAS THIS ARTICLE HELPFUL?

Helpful

Not Helpful