H5DatasetCollection Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

A class which represents a collection of datasets below a certain group node in an HDF5 file. This class is used internally by ILNumerics.

[ILNumerics HDF5 Module]

Inheritance Hierarchy

SystemObject
  ILNumerics.IO.HDF5H5Object
    ILNumerics.IO.HDF5H5CollectionH5Dataset
      ILNumerics.IO.HDF5H5DatasetCollection

Namespace: ILNumerics.IO.HDF5
Assembly: ILNumerics.IO.HDF5 (in ILNumerics.IO.HDF5.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public class H5DatasetCollection : H5Collection<H5Dataset>

Public Class H5DatasetCollection
	Inherits H5Collection(Of H5Dataset)

Dim instance As H5DatasetCollection

The H5DatasetCollection type exposes the following members.

Constructors

	Name	Description
	H5DatasetCollection	Creates a new dataset collection. This is rarely be used explicitly. [ILNumerics HDF5 Module]

Properties

	Name	Description
	Count	(Inherited from H5CollectionT.)
	File	The HDF5 file this object is originated from. [ILNumerics HDF5 Module] (Inherited from H5Object.)
	H5Type	(Overrides H5ObjectH5Type.)
	IsReadOnly	(Inherited from H5CollectionT.)
	Name	Gets the local name of the object, i.e. the last segment from the absolute path [ILNumerics HDF5 Module] (Inherited from H5Object.)
	NameEncoding	Gets the local object name encoding type. [ILNumerics HDF5 Module] (Inherited from H5Object.)
	Path	Unique object identifier, commonly the absolute path to the object in the HDF5 file [ILNumerics HDF5 Module] (Inherited from H5Object.)

Methods

	Name	Description
	Add(H5Dataset)	Adds a new dataset to the collection of datasets. The new object is expected to not exist in the file already. [ILNumerics HDF5 Module] (Overrides H5CollectionTAdd(T).)
	Add(String, BaseArray, BaseArray, Type, Object, H5Compression, UInt32)	Create a new dataset and add it to the current group [ILNumerics HDF5 Module]
	Clear	Clears all objects in this collection - in memory AND FROM THE FILE! [ILNumerics HDF5 Module] (Inherited from H5CollectionT.)
	Contains	(Inherited from H5CollectionT.)
	CopyTo	(Inherited from H5CollectionT.)
	Equals	(Inherited from H5Object.)
	GetHashCode	(Inherited from H5Object.)
	getObjectsObjT	(Inherited from H5CollectionT.)
	Remove	(Inherited from H5CollectionT.)
	ToString	(Inherited from H5Object.)

Fields

Extension Methods

	Name	Description
	GetH5ID	Retrieves the object ID used to identify the object within the HDF5 file /// [ILNumerics HDF5 Module] (Defined by Helper.)

Remarks

[ILNumerics HDF5 Module]