ILNumerics - Technical Application Development
SystemObject
ILNumerics.IO.HDF5H5Object
ILNumerics.IO.HDF5H5CollectionH5Object
ILNumerics.IO.HDF5H5Group
ILNumerics.IO.HDF5H5File
Assembly: ILNumerics.IO.HDF5 (in ILNumerics.IO.HDF5.dll) Version: 5.5.0.0 (5.5.7503.3146)
Top
Top
Top
Top
Top
See the online manual for examples and HowTos: http://ilnumerics.net/hdf5-interface.html
H5File represents a HDF5 file. It is the root object used to access and manage all features in ILNumerics.IO.HDF5.
[ILNumerics HDF5 Module]
Inheritance Hierarchy
ILNumerics.IO.HDF5H5Object
ILNumerics.IO.HDF5H5CollectionH5Object
ILNumerics.IO.HDF5H5Group
ILNumerics.IO.HDF5H5File
Namespace: ILNumerics.IO.HDF5
Assembly: ILNumerics.IO.HDF5 (in ILNumerics.IO.HDF5.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax
The H5File type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | H5File(String, String, Int64) | Initializes a new instance of the H5File class |
| H5File(String, FileMode, FileAccess, Int64) |
Create a new H5File object corresponding to a HDF5 file
[ILNumerics HDF5 Module] |
Properties
| Name | Description | |
|---|---|---|
 | Attributes |
Access to the collection of attributes for this object
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| Count | (Inherited from H5CollectionT.) |
| Datasets |
Gets the collection of datasets contained within this group node by walking the subtree recursively
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| Datatypes |
Gets a collection of all data type definitions within the subtree below this group
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| File |
The HDF5 file this object is originated from.
(Inherited from H5Object.)[ILNumerics HDF5 Module] |
| Filename |
The filename of the underlying H5F file. This must be a relative or absolute file path. (readonly)
[ILNumerics HDF5 Module] |
| Groups |
Gets a collection of all groups contained within the subtree below this group
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| H5Type |
The type of the node: H5NodeTypes.Group
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| ID |
The file ID used to identify the connection to the underlying HDF5 file; readonly
[ILNumerics HDF5 Module] |
| IsReadOnly | (Inherited from H5CollectionT.) |
| Item |
Gets an object by name / key or creates a hardlink to it
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| Name |
Gets the local name of the object, i.e. the last segment from the absolute path
(Inherited from H5Object.)[ILNumerics HDF5 Module] |
| NameEncoding |
Gets the local object name encoding type.
(Inherited from H5Object.)[ILNumerics HDF5 Module] |
| Path |
Unique object identifier, commonly the absolute path to the object in the HDF5 file
(Inherited from H5Object.)[ILNumerics HDF5 Module] |
Methods
| Name | Description | |
|---|---|---|
| Add |
Adds a new object to the file this group is in, if such an object does not already exist
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| Clear |
Clears all objects in this collection - in memory AND FROM THE FILE!
(Inherited from H5CollectionT.)[ILNumerics HDF5 Module] |
| Contains | (Inherited from H5CollectionT.) |
| CopyTo | (Inherited from H5CollectionT.) |
| Dispose |
Flushes any unwritten data and closes the underlying HDF5 file. This method does not delete any data from the HDF5 file.
[ILNumerics HDF5 Module] |
 | Dispose(Boolean) | Releases the unmanaged resources used by the H5File and optionally releases the managed resources |
| Equals | (Inherited from H5Object.) |
| Finalize | (Overrides ObjectFinalize.) |
| GetT |
Get a typed object by path / name
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| GetHashCode | (Inherited from H5Object.) |
| getObjectsObjT | (Inherited from H5CollectionT.) |
| OpenCreate | |
| Remove(T) | (Inherited from H5CollectionT.) |
| Remove(String) |
Removes an object from the node
(Inherited from H5Group.)[ILNumerics HDF5 Module] |
| ToString |
Gives a short string representation for this HDF5 file.
(Overrides H5ObjectToString.)[ILNumerics HDF5 Module] |
Fields
| Name | Description | |
|---|---|---|
 | m_address | (Inherited from H5Object.) |
| m_file | (Inherited from H5Object.) |
| m_filename | |
| m_path | (Inherited from H5Object.) |
Extension Methods
| Name | Description | |
|---|---|---|
  | FindTObjT |
Finds any matching object among the children of this group
(Defined by Helper.)[ILNumerics HDF5 Module] |
| FirstObjT |
Find and return the first matching object from the children of this group
(Defined by Helper.)[ILNumerics HDF5 Module] |
| GetH5ID |
Retrieves the object ID used to identify the object within the HDF5 file
///
(Defined by Helper.)[ILNumerics HDF5 Module] |
Remarks
[ILNumerics HDF5 Module]
See Also