H5T_ENUM-class

H5T_ENUM

Inherits from class <code>H5T</code>.

'HDF5' is a data model, library and file format for storing
and managing large amounts of data. This package provides a nearly
feature complete, object oriented wrapper for the 'HDF5' API
<https://support.hdfgroup.org/HDF5/doc/RM/RM_H5Front.html> using R6 classes.
Additionally, functionality is added so that 'HDF5' objects behave very
similar to their corresponding R counterparts.

Holger Hoefling

hdf5r

Interface to the 'HDF5' Binary Data Format

Mario Annau

Novartis Institute for BioMedical Research (NIBR) 

H5T_ENUM-class function

<dl>
<dt><code>new(labels, values = seq_along(labels), id = NULL)</code></dt>
<dd></dd></dl>Create an enumeration datatype. This is either a factor-like object or a logical variable (that is
internally represented as an ENUM-type.
Parameters<dl>
<dt>labels</dt>
<dd>The labels of the ENUM-type</dd><dt>values</dt>
<dd>The values corresponding to the labels</dd><dt>id</dt>
<dd>Internal use only</dd>
</dl>
<dt><code>get_labels()</code></dt>
<dd></dd>Return all the labels of the enumeration type
<dt><code>get_values()</code></dt>
<dd></dd>Return the values of the enumeration type
<dt><code>set_size(size)</code></dt>
<dd></dd>Base type of every enum is <code>H5T_INTEGER</code>. This disables the set_size function
<dt><code>get_super()</code></dt>
<dd></dd>Returns <code>H5T_INTEGER</code> that is the base type of the enumeration
<dt><code>describe()</code></dt>
<dd></dd>Print a detailed description of the datatype; this is experimental

Methods

Author

Class for HDF5 enumeration datatypes. — H5T_ENUM-class

<dl>
<dt><code>new(labels, values = seq_along(labels), id = NULL)</code></dt>
<dd>

Create an enumeration datatype. This is either a factor-like object or a logical variable (that is
internally represented as an ENUM-type.
Parameters<dl>
<dt>labels</dt>
<dd>The labels of the ENUM-type</dd>

<dt>values</dt>
<dd>The values corresponding to the labels</dd>

<dt>id</dt>
<dd>Internal use only</dd>


</dl></dd>


<dt><code>get_labels()</code></dt>
<dd>

Return all the labels of the enumeration type</dd>


<dt><code>get_values()</code></dt>
<dd>

Return the values of the enumeration type</dd>


<dt><code>set_size(size)</code></dt>
<dd>

Base type of every enum is <code>H5T_INTEGER</code>. This disables the set_size function</dd>


<dt><code>get_super()</code></dt>
<dd>

Returns <code>H5T_INTEGER</code> that is the base type of the enumeration</dd>


<dt><code>describe()</code></dt>
<dd>

Print a detailed description of the datatype; this is experimental</dd>


</dl>

H5T_ENUM-class: Class for HDF5 enumeration datatypes.

Description

Arguments

Value

Methods

Author

See Also

Examples