H5Group Constructor

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Create a new empty group for adding to an HDF5 file

[ILNumerics HDF5 Module]

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

Syntax

Copy

public H5Group(
	string name
)

Public Sub New ( 
	name As String
)

Dim name As String

Dim instance As New H5Group(name)

Parameters

name: Type: SystemString
The name of the new group. Allowed: single name identifier, absolute or relative paths

Remarks

The name may be specified as a single name identifier, consisting out of chars, digits and underscores. A new group with that name will be created.

If the name contains slashes '/', it will be interpreted as path, having several groups involved. If the path begins with a slash '/' it is taken as an absolute path, otherwise it is interpreted as a relative path. Absolute paths always refer to the root group of the HDF5 file.

If an relative path is given, it refers to the group node, this newly created node is going to be added to.

Creating a new H5Group does not lead to the immediate creation of a new object in the HDF5 file! The file is only altered, as soon as the new object is added to any group, already existing in the HDF5 file.

Examples

Copy

using (var file = new H5File("filename.h")) {
                var group = new H5Group("g1"); // this will only create a small proxy group object
                file.Add(group); // a new group with the path /g1 will actually get created in the HDF5 file here
                file.Add(                      // adding the /g2 group to the file will alter the HDF5 file   
                    new H5Group("g2") {        // create a new group relative to the root node: /g2
                        new H5Group("g3"),     // create a new group in g2: /g2/g3
                        new H5Group("g4/g5"),  // create 2 new groups: /g2/g4 and /g2/g4/g5
                                               // if an absolute path is given, the position of the new group in the node tree is ignored: 
                        new H5Group("/base1/base2")  // creates /base1/base2  (instead of /g2/base1/base2 !)
                    });
            }

[ILNumerics HDF5 Module]

Reference

H5Group Class

ILNumerics.IO.HDF5 Namespace