H5StringDataset Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

This class represents a dataset with string element types.

[ILNumerics HDF5 Module]

Inheritance Hierarchy

SystemObject
  ILNumerics.IO.HDF5H5Object
    ILNumerics.IO.HDF5H5Dataset
      ILNumerics.IO.HDF5H5StringDataset

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 sealed class H5StringDataset : H5Dataset

Public NotInheritable Class H5StringDataset
	Inherits H5Dataset

Dim instance As H5StringDataset

The H5StringDataset type exposes the following members.

Constructors

	Name	Description
	H5StringDataset	Create a new dataset, storing an array of strings. [ILNumerics HDF5 Module]

Top

Properties

	Name	Description
	Attributes	Gets access to the collection of attributes for this object. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	Class	Gets the HDF5 base type used to store the elements. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	Compression	Gets the compression method configured for the dataset [readonly]. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	CompressionParameter	Additional parameter for compression method [readonly]. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	ContentEncoding	Get the string encoding used to store the containing data string elements. Supported values: ASCII or UTF8. [ILNumerics HDF5 Module]
	File	The HDF5 file this object is originated from. [ILNumerics HDF5 Module] (Inherited from H5Object.)
	H5Type	Gets the object type of this dataset. This will always return 'H5ObjectTypes.Dataset'. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	Length	Gets the length (number of bytes) of the string elements."/>. [ILNumerics HDF5 Module]
	MaxSize	The maximum dimension sizes configured [readonly]. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	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.)
	Padding	Gets the padding characters used to fill remaining characters in fixed length string elements which do not fill up to the specified fixed length byte length. [ILNumerics HDF5 Module]
	Path	Unique object identifier, commonly the absolute path to the object in the HDF5 file [ILNumerics HDF5 Module] (Inherited from H5Object.)
	Size	Gets the current size of the dataset [readonly]. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)

Top

Methods

	Name	Description
	Equals	(Inherited from H5Object.)
	Get(BaseArray)	Retrieve (sub-)array of strings from dataset. [ILNumerics HDF5 Module]
	Get(BaseArray, NullableStringPadding)	Retrieve (sub-)array of strings from dataset. [ILNumerics HDF5 Module]
	GetFillValueT	Gives the user defined fill value for the data set. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	GetHashCode	(Inherited from H5Object.)
	Set(BaseArrayString, BaseArray)	Alter the existing data stored in the file or parts of it. [ILNumerics HDF5 Module]
	Set(BaseArrayString, StringPadding, BaseArray)	Alter the existing data stored in the file or parts of it. [ILNumerics HDF5 Module]
	SetT(BaseArrayT, BaseArray)	Alter the existing data stored in the file or parts of it. [ILNumerics HDF5 Module] (Inherited from H5Dataset.)
	SetT(BaseArrayT, BaseArray)	Alter elements of this dataset. Optionally provide a description of the range. [ILNumerics HDF5 Module] (Overrides H5DatasetSetT(BaseArrayT, BaseArray).)
	ToString	(Inherited from H5Object.)

Top

Extension Methods

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

Top

Remarks

[ILNumerics HDF5 Module]

Reference

ILNumerics.IO.HDF5 Namespace