ILNumerics Ultimate VS

H5Group Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
H5Group represents groups in HDF5 files

[ILNumerics HDF5 Module]

Inheritance Hierarchy

SystemObject
  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

public class H5Group : H5Collection<H5Object>

The H5Group type exposes the following members.

Constructors

  NameDescription
Public methodH5Group
Create a new empty group for adding to an HDF5 file

[ILNumerics HDF5 Module]

Top
Properties

  NameDescription
Public propertyAttributes
Access to the collection of attributes for this object

[ILNumerics HDF5 Module]

Public propertyCount (Inherited from H5CollectionT.)
Public propertyDatasets
Gets the collection of datasets contained within this group node by walking the subtree recursively

[ILNumerics HDF5 Module]

Public propertyDatatypes
Gets a collection of all data type definitions within the subtree below this group

[ILNumerics HDF5 Module]

Public propertyFile
The HDF5 file this object is originated from.

[ILNumerics HDF5 Module]

(Inherited from H5Object.)
Public propertyGroups
Gets a collection of all groups contained within the subtree below this group

[ILNumerics HDF5 Module]

Public propertyH5Type
The type of the node: H5NodeTypes.Group

[ILNumerics HDF5 Module]

(Overrides H5ObjectH5Type.)
Public propertyIsReadOnly (Inherited from H5CollectionT.)
Public propertyItem
Gets an object by name / key or creates a hardlink to it

[ILNumerics HDF5 Module]

Public propertyName
Gets the local name of the object, i.e. the last segment from the absolute path

[ILNumerics HDF5 Module]

(Inherited from H5Object.)
Public propertyNameEncoding
Gets the local object name encoding type.

[ILNumerics HDF5 Module]

(Inherited from H5Object.)
Public propertyPath
Unique object identifier, commonly the absolute path to the object in the HDF5 file

[ILNumerics HDF5 Module]

(Inherited from H5Object.)
Top
Methods

  NameDescription
Public methodAdd
Adds a new object to the file this group is in, if such an object does not already exist

[ILNumerics HDF5 Module]

(Overrides H5CollectionTAdd(T).)
Public methodClear
Clears all objects in this collection - in memory AND FROM THE FILE!

[ILNumerics HDF5 Module]

(Inherited from H5CollectionT.)
Public methodContains (Inherited from H5CollectionT.)
Public methodCopyTo (Inherited from H5CollectionT.)
Public methodEquals (Inherited from H5Object.)
Public methodGetT
Get a typed object by path / name

[ILNumerics HDF5 Module]

Public methodGetHashCode (Inherited from H5Object.)
Protected methodgetObjectsObjT (Inherited from H5CollectionT.)
Public methodRemove(T) (Inherited from H5CollectionT.)
Public methodRemove(String)
Removes an object from the node

[ILNumerics HDF5 Module]

Public methodToString (Inherited from H5Object.)
Top
Fields

  NameDescription
Protected fieldm_address (Inherited from H5Object.)
Protected fieldm_file (Inherited from H5Object.)
Protected fieldm_path (Inherited from H5Object.)
Top
Extension Methods

  NameDescription
Public Extension MethodCode exampleFindTObjT
Finds any matching object among the children of this group

[ILNumerics HDF5 Module]

(Defined by Helper.)
Public Extension MethodCode exampleFirstObjT
Find and return the first matching object from the children of this group

[ILNumerics HDF5 Module]

(Defined by Helper.)
Public Extension MethodGetH5ID
Retrieves the object ID used to identify the object within the HDF5 file ///

[ILNumerics HDF5 Module]

(Defined by Helper.)
Top
Remarks

[ILNumerics HDF5 Module]

See Also

Reference