Class H5File
An HDF5 file object. This is the entry-point to work with HDF5 files.
Implements
Inherited Members
Namespace: HDF5.NET
Assembly: HDF5.NET.dll
Syntax
public class H5File : H5Group, IDisposable
Fields
| Improve this Doc View SourceDefaultChunkCacheFactory
The default chunk cache factory.
Declaration
public static Func<IChunkCache> DefaultChunkCacheFactory
Field Value
Type | Description |
---|---|
System.Func<IChunkCache> |
Properties
| Improve this Doc View SourceChunkCacheFactory
Gets or sets the current chunk cache factory.
Declaration
public Func<IChunkCache> ChunkCacheFactory { get; set; }
Property Value
Type | Description |
---|---|
System.Func<IChunkCache> |
Path
Gets the path of the opened HDF5 file. The value is :memory: if the file is not loaded from a file system.
Declaration
public string Path { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceDispose()
An HDF5 file object. This is the entry-point to work with HDF5 files.
Declaration
public void Dispose()
Open(Stream)
Opens an HDF5 stream.
Declaration
public static H5File Open(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The stream to open. |
Returns
Type | Description |
---|---|
H5File |
Open(String, FileMode, FileAccess, FileShare, Boolean)
Opens an HDF5 file.
Declaration
public static H5File Open(string filePath, FileMode mode, FileAccess fileAccess, FileShare fileShare, bool useAsync = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | The file to open. |
System.IO.FileMode | mode | A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten. |
System.IO.FileAccess | fileAccess | A System.IO.FileAccess value that specifies the operations that can be performed on the file. |
System.IO.FileShare | fileShare | A System.IO.FileShare value specifying the type of access other threads have to the file. |
System.Boolean | useAsync | A boolean which indicates if the file be opened with the System.IO.FileOptions.Asynchronous flag. |
Returns
Type | Description |
---|---|
H5File |
OpenRead(String)
Opens an HDF5 file for reading. Please see the Remarks section for more information how the file is opened.
Declaration
public static H5File OpenRead(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | The file to open. |
Returns
Type | Description |
---|---|
H5File |