H5R_OBJECT-class

H5R_OBJECT

<code>H5R_OBJECT</code> is the reference class for objects. Users should not create this class by themselves, but use the appropriate 
and instead use the <code>create_reference</code> methods of <code>H5D</code>, <code>H5Group</code> or <code>H5File</code> classes.

'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) 

H5R_OBJECT-class function

<dl>
<dt><code>new(num = 0, id = NULL)</code></dt>
<dd></dd></dl>Create a new reference for object; Usually, users shouldn't have to call this, but use the <code>create_reference</code>
method of a dataset, group of committed datatype
<dt><code>dereference(object_access_pl = h5const$H5P_DEFAULT, obj = NULL)</code></dt>
<dd></dd>Dereference an H5R reference. The file the reference is pointing to is assigned automatically
This function implements the HDF5-API function H5Rdereference.
Please see the documentation at <a href="https://docs.hdfgroup.org/hdf5/v1_10/group___h5_r.html">https://docs.hdfgroup.org/hdf5/v1_10/group___h5_r.html</a> for details.
Parameters<dl>
<dt>obj</dt>
<dd>Overriding the default file the reference is referring to</dd><dt>object_access_pl</dt>
<dd>The object-access property list. Currently always the default</dd>
</dl>

Methods

Author

Class for HDF5 Object-references. — H5R_OBJECT-class

<dl>
<dt><code>new(num = 0, id = NULL)</code></dt>
<dd>

Create a new reference for object; Usually, users shouldn't have to call this, but use the <code>create_reference</code>
method of a dataset, group of committed datatype</dd>


<dt><code>dereference(object_access_pl = h5const$H5P_DEFAULT, obj = NULL)</code></dt>
<dd>

Dereference an H5R reference. The file the reference is pointing to is assigned automatically
This function implements the HDF5-API function H5Rdereference.
Please see the documentation at <a href='https://docs.hdfgroup.org/hdf5/v1_10/group___h5_r.html'>https://docs.hdfgroup.org/hdf5/v1_10/group___h5_r.html</a> for details.
Parameters<dl>
<dt>obj</dt>
<dd>Overriding the default file the reference is referring to</dd>

<dt>object_access_pl</dt>
<dd>The object-access property list. Currently always the default</dd>


</dl></dd>


</dl>

H5R_OBJECT-class: Class for HDF5 Object-references.

Description

Arguments

Value

Methods

Author