Class H5File

Namespace

PureHDF

Assembly

PureHDF.dll

Entry-point for PureHDF.

public class H5File : H5Group, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable

Inheritance

object

H5Object

H5Group

H5File

Implements

IDictionary<string, object>

ICollection<KeyValuePair<string, object>>

IEnumerable<KeyValuePair<string, object>>

IEnumerable

Inherited Members

H5Group.Add(string, object)

H5Group.Add(KeyValuePair<string, object>)

H5Group.Clear()

H5Group.Contains(KeyValuePair<string, object>)

H5Group.ContainsKey(string)

H5Group.CopyTo(KeyValuePair<string, object>[], int)

H5Group.GetEnumerator()

H5Group.Remove(string)

H5Group.Remove(KeyValuePair<string, object>)

H5Group.TryGetValue(string, out object)

H5Group.this[string]

H5Group.Keys

H5Group.Values

H5Group.Count

H5Group.IsReadOnly

H5Object.Attributes

Constructors

H5File()

public H5File()

Methods

BeginWrite(Stream, H5WriteOptions?)

Writes the contents to the specified stream and returns a writer which allows to write more data to the stream until the writer gets disposed.

public H5NativeWriter BeginWrite(Stream stream, H5WriteOptions? options = null)

Parameters

stream Stream

The stream to write the contents into. It must be readable, writeable and seekable.

options H5WriteOptions

Options to control encoding behavior.

Returns

H5NativeWriter

BeginWrite(string, H5WriteOptions?)

Creates a new file, write the contents to the file and returns a writer which allows to write more data to the file until the writer gets disposed. If the target file already exists, it is overwritten.

public H5NativeWriter BeginWrite(string filePath, H5WriteOptions? options = null)

Parameters

filePath string

The path of the file to write the contents into.

options H5WriteOptions

Options to control encoding behavior.

Returns

H5NativeWriter

Open(MemoryMappedViewAccessor, H5ReadOptions?)

Opens an HDF5 memory-mapped file.

public static NativeFile Open(MemoryMappedViewAccessor accessor, H5ReadOptions? options = null)

Parameters

accessor MemoryMappedViewAccessor

The memory-mapped accessor to use.

options H5ReadOptions

Options to control decoding behavior.

Returns

NativeFile

Open(Stream, bool, H5ReadOptions?)

Opens an HDF5 stream.

public static NativeFile Open(Stream stream, bool leaveOpen = false, H5ReadOptions? options = null)

Parameters

stream Stream

The stream to use. It must be readable and seekable.

leaveOpen bool

A boolean which indicates if the stream should be kept open when this class is disposed. The default is false.

options H5ReadOptions

Options to control decoding behavior.

Returns

NativeFile

Open(string, FileMode, FileAccess, FileShare, H5ReadOptions?)

Opens an HDF5 file.

public static NativeFile Open(string filePath, FileMode mode, FileAccess fileAccess, FileShare fileShare, H5ReadOptions? options = null)

Parameters

filePath string

The path of the file to open.

mode FileMode

A 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.

fileAccess FileAccess

A FileAccess value that specifies the operations that can be performed on the file.

fileShare FileShare

A FileShare value specifying the type of access other threads have to the file.

options H5ReadOptions

Options to control decoding behavior.

Returns

NativeFile

OpenRead(string, H5ReadOptions?)

Opens an HDF5 file for reading. Please see the Remarks section for more information how the file is opened.

public static NativeFile OpenRead(string filePath, H5ReadOptions? options = null)

Parameters

filePath string

The path of the file to open.

options H5ReadOptions

Options to control decoding behavior.

Returns

NativeFile

Write(Stream, H5WriteOptions?)

Writes the contents to the specified stream.

public void Write(Stream stream, H5WriteOptions? options = null)

Parameters

stream Stream

The stream to write the contents into. It must be readable, writeable and seekable.

options H5WriteOptions

Options to control encoding behavior.

Write(string, H5WriteOptions?)

Creates a new file, write the contents to the file, and then closes the file. If the target file already exists, it is overwritten.

public void Write(string filePath, H5WriteOptions? options = null)

Parameters

filePath string

The path of the file to write the contents into.

options H5WriteOptions

Options to control encoding behavior.