File (FSharp.Data.Tdms)

File Module

Namespace: FSharp.Data.Tdms
Assembly: FSharp.Data.Tdms.dll

Functions and values

Function or value	Description
`LeadInLength` Full Usage: `LeadInLength` Returns: `int`	Returns: `int`
`findChannel groupName channelName` Full Usage: `findChannel groupName channelName` Parameters: groupName : `string` - the name of the Group to find the Channel in. channelName : `string` - the name of the Channel to find. Returns: `File -> Channel`	Returns the Channel with the given name within the Group with the given name. groupName : `string` the name of the Group to find the Channel in. channelName : `string` the name of the Channel to find. Returns: `File -> Channel`
`findGroup groupName` Full Usage: `findGroup groupName` Parameters: groupName : `string` - the name of the Group to find. Returns: `File -> Group`	Returns the Group with the given name within the File. groupName : `string` the name of the Group to find. Returns: `File -> Group`
`getGroups arg1` Full Usage: `getGroups arg1` Parameters: arg0 : `File` Returns: `seq<Group>`	Returns all groups within the File. arg0 : `File` Returns: `seq<Group>`
`getPropertyValue propertyName` Full Usage: `getPropertyValue propertyName` Parameters: propertyName : `string` Returns: `File -> 't`	propertyName : `string` Returns: `File -> 't`
`ofObjects path objects` Full Usage: `ofObjects path objects` Parameters: path : `string` objects : `seq<Object>` Returns: `File`	path : `string` objects : `seq<Object>` Returns: `File`
`read path writeIndex` Full Usage: `read path writeIndex` Parameters: path : `string` - the path to the File to read. writeIndex : `bool` - Whether to write the TDMS index file if it does not exist. Returns: `File`	Opens a File, reads the index from it, and closes it. path : `string` the path to the File to read. writeIndex : `bool` Whether to write the TDMS index file if it does not exist. Returns: `File`
`readAsync` Full Usage: `readAsync` Returns: `string -> bool -> Task<File>`	Asynchronously opens a File, reads the index from it, and closes it. Returns: `string -> bool -> Task<File>`
`readAsyncCt ct path writeIndex` Full Usage: `readAsyncCt ct path writeIndex` Parameters: ct : `CancellationToken` path : `string` writeIndex : `bool` Returns: `Task<File>`	ct : `CancellationToken` path : `string` writeIndex : `bool` Returns: `Task<File>`
`tryFindChannel groupName channelName` Full Usage: `tryFindChannel groupName channelName` Parameters: groupName : `string` - the name of the Group to find the Channel in. channelName : `string` - the name of the Channel to find. Returns: `File -> Channel option`	Returns the Channel with the given name within the Group with the given name within the File. Returns None if it does not exist. groupName : `string` the name of the Group to find the Channel in. channelName : `string` the name of the Channel to find. Returns: `File -> Channel option`
`tryFindGroup groupName` Full Usage: `tryFindGroup groupName` Parameters: groupName : `string` - the name of the Group to find. Returns: `File -> Group option`	Returns the Group with the given name within the File. Returns None if it does not exist. groupName : `string` the name of the Group to find. Returns: `File -> Group option`
`tryGetPropertyValue propertyName arg2` Full Usage: `tryGetPropertyValue propertyName arg2` Parameters: propertyName : `string` arg1 : `File` Returns: `'t option`	propertyName : `string` arg1 : `File` Returns: `'t option`
`tryGetRawData groupName channelName file` Full Usage: `tryGetRawData groupName channelName file` Parameters: groupName : `string` - the name of the Group the Channel is in. channelName : `string` - the name of the Channel to get raw data for. file : `File` - the TDMS file to read from. Returns: `'t[] option`	Returns the raw data for a Channel. Returns None if the Channel does not exist, if it does not have any raw data, or if its raw data is not of the given type. groupName : `string` the name of the Group the Channel is in. channelName : `string` the name of the Channel to get raw data for. file : `File` the TDMS file to read from. Returns: `'t[] option`
`tryGetRawDataAsync` Full Usage: `tryGetRawDataAsync` Returns: `string -> string -> File -> Task<'t[] option>`	Returns: `string -> string -> File -> Task<'t[] option>`
`tryGetRawDataAsyncCt ct groupName channelName file` Full Usage: `tryGetRawDataAsyncCt ct groupName channelName file` Parameters: ct : `CancellationToken` groupName : `string` - the name of the Group the Channel is in. channelName : `string` - the name of the Channel to get raw data for. file : `File` - the TDMS file to read from. Returns: `Task<'t[] option>`	Asynchronously returns the raw data for a Channel. Returns None if the Channel does not exist, if it does not have any raw data, or if its raw data is not of the given type. ct : `CancellationToken` groupName : `string` the name of the Group the Channel is in. channelName : `string` the name of the Channel to get raw data for. file : `File` the TDMS file to read from. Returns: `Task<'t[] option>`