File (FSharp.Data.Tdms)

File Type

Namespace: FSharp.Data.Tdms
Assembly: FSharp.Data.Tdms.dll
Base Type: obj
All Interfaces: IEquatable<File> , IStructuralEquatable

Record fields

Record Field	Description
`Groups` Full Usage: `Groups` Field type: `seq<Group>`	Field type: `seq<Group>`
`Path` Full Usage: `Path` Field type: `string`	Field type: `string`
`Properties` Full Usage: `Properties` Field type: `seq<Property>`	Field type: `seq<Property>`

Instance members

Instance member	Description
`this.GetRawDataAsync` Full Usage: `this.GetRawDataAsync` Parameters: groupName : `string` channelName : `string` ?ct : `CancellationToken` Returns: `Task<'t[]>`	Asynchronously gets the raw data for the given channel, belonging to the given group in the given TDMS file. groupName : `string` channelName : `string` ?ct : `CancellationToken` Returns: `Task<'t[]>`
`this.TryGetPropertyValue` Full Usage: `this.TryGetPropertyValue` Parameters: propertyName : `obj` groupName : `string` channelName : `string` propertyValue : `byref<'T>` Returns: `bool`	Tries to get a property value for the given channel, belonging to the given group in the given TDMS file. propertyName : `obj` groupName : `string` channelName : `string` propertyValue : `byref<'T>` Returns: `bool`
`this.TryGetPropertyValue` Full Usage: `this.TryGetPropertyValue` Parameters: propertyName : `string` groupName : `string` propertyValue : `byref<'T>` Returns: `bool`	Tries to get a property value for the given group in the given TDMS file. propertyName : `string` groupName : `string` propertyValue : `byref<'T>` Returns: `bool`
`this.TryGetPropertyValue` Full Usage: `this.TryGetPropertyValue` Parameters: propertyName : `string` propertyValue : `byref<'T>` Returns: `bool`	Tries to get a property value for the given TDMS file. propertyName : `string` propertyValue : `byref<'T>` Returns: `bool`
`this.TryGetRawData` Full Usage: `this.TryGetRawData` Parameters: groupName : `string` channelName : `string` rawData : `byref<'T[]>` Returns: `bool`	Tries to get the raw data for the given channel, belonging to the given group in the given TDMS file. groupName : `string` channelName : `string` rawData : `byref<'T[]>` Returns: `bool`

Static members

Static member Description

Static member	Description
`File.Read(path, writeIndex)` Full Usage: `File.Read(path, writeIndex)` Parameters: path : `string` - The path to the TDMS file to read. writeIndex : `bool` - Whether to write the TDMS index file. Returns: `File`	Opens a TDMS file, reads the index from it, and closes it. path : `string` The path to the TDMS file to read. writeIndex : `bool` Whether to write the TDMS index file. Returns: `File`
`File.ReadAsync(path, writeIndex, ?ct)` Full Usage: `File.ReadAsync(path, writeIndex, ?ct)` Parameters: path : `string` - The path to the TDMS file to read. writeIndex : `bool` - Whether to write the TDMS index file. ?ct : `CancellationToken` Returns: `Task<File>`	Asynchronously opens a TDMS file, reads the index from it, and closes it. path : `string` The path to the TDMS file to read. writeIndex : `bool` Whether to write the TDMS index file. ?ct : `CancellationToken` Returns: `Task<File>`


                
                  
                    
                      File.Read(path, writeIndex)

Full Usage: File.Read(path, writeIndex)

Parameters:

path : string - The path to the TDMS file to read.

writeIndex : bool - Whether to write the TDMS index file.

Returns: File

Opens a TDMS file, reads the index from it, and closes it.

path : string: The path to the TDMS file to read.
writeIndex : bool: Whether to write the TDMS index file.

Returns: File


                
                  
                    
                      File.ReadAsync(path, writeIndex, ?ct)

Full Usage: File.ReadAsync(path, writeIndex, ?ct)

Parameters:

path : string - The path to the TDMS file to read.

writeIndex : bool - Whether to write the TDMS index file.

?ct : CancellationToken

Returns: Task<File>

Asynchronously opens a TDMS file, reads the index from it, and closes it.

path : string: The path to the TDMS file to read.
writeIndex : bool: Whether to write the TDMS index file.
?ct : CancellationToken

Returns: Task<File>