H5StringAttribute Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

An attribute which stores string data. This is a specialization of the general H5Attribute class for string data elements. It adds certain properties to the base H5Attribute, which make it easier for string handling.

[ILNumerics HDF5 Module]

Inheritance Hierarchy

SystemObject
  ILNumerics.IO.HDF5H5Object
    ILNumerics.IO.HDF5H5Attribute
      ILNumerics.IO.HDF5H5StringAttribute

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 H5StringAttribute : H5Attribute

Public NotInheritable Class H5StringAttribute
	Inherits H5Attribute

Dim instance As H5StringAttribute

The H5StringAttribute type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Class	Gets the HDF5 class of the base type used to store the elements. [ILNumerics HDF5 Module] (Inherited from H5Attribute.)
	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	Returns Attribute. [ILNumerics HDF5 Module] (Inherited from H5Attribute.)
	Length	Gets the length (number of bytes) of the string elements. See: Add(H5StringAttribute). [ILNumerics HDF5 Module]
	Name	The name of the attribute. This corresponds to the last sub-segment of the path used to identify the attribute in the object hierarchy. [ILNumerics HDF5 Module] (Inherited from H5Attribute.)
	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 size of the attribute (number and length of the dimensions). [ILNumerics HDF5 Module] (Inherited from H5Attribute.)

Top

Methods

	Name	Description
	Equals	(Inherited from H5Object.)
	Get(NullableStringPadding)	Retrieve the attribute value(s) as ILNumerics array. [ILNumerics HDF5 Module]
	GetT	Retrieve attribute value as ILNumerics array. [ILNumerics HDF5 Module] (Inherited from H5Attribute.)
	GetHashCode	(Inherited from H5Object.)
	Set(InArrayString, NullableStringEncoding, NullableInt32, NullableInt32, NullableStringPadding)	Alter the data of this string attribute. [ILNumerics HDF5 Module]
	SetT(BaseArrayT)	Modify the content of this attribute. [ILNumerics HDF5 Module] (Inherited from H5Attribute.)
	SetT(BaseArrayT)	Modify the content of this attribute. [ILNumerics HDF5 Module] (Overrides H5AttributeSetT(BaseArrayT).)
	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