1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/R6Classes.R
\docType{class}
\name{H5RefClass-class}
\alias{H5RefClass-class}
\alias{H5RefClass}
\title{Base class that tracks the ids and allows for closing an id}
\value{
Object of reference class \code{\link{H5RefClass}}.
}
\description{
This class is not intended for creating objects, but as a base class for all other
H5-derived classes to provide common functionality for id tracking
}
\section{Fields}{
\describe{
\item{\code{id}}{Returns the id of the object as an integer}
}}
\section{Methods}{
\describe{
\item{\code{new(id = NULL)}}{
Constructor for the basic class for hdf5 objects. Takes an id and stores it appropriately, including
the necessary counting of object references that the package implements. This reference counting is
included in addition to R's internal method in order to allow for the invalidation of objects
in R itself when all open handles in an R-file are being closed.}
\item{\code{close()}}{
Closes an object and calls the appropriate HDF5 function for the type of object}
\item{\code{print(...)}}{
Prints the class of the object and the id}
\item{\code{methods()}}{
Prints available methods on the screen}
\item{\code{get_file_id()}}{
This function implements the HDF5-API function H5Iget_file_id.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_GET_FILE_ID} for details.}
\item{\code{get_obj_type()}}{
This function implements the HDF5-API function H5Iget_type.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_GET_TYPE} for details.}
\item{\code{get_ref()}}{
This function implements the HDF5-API function H5Iget_ref.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_GET_REF} for details.}
\item{\code{inc_ref()}}{
This function implements the HDF5-API function H5Iinc_ref.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_INC_REF} for details.}
\item{\code{dec_ref()}}{
This function implements the HDF5-API function H5Idec_ref.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_DEC_REF} for details.}
\item{\code{id()}}{
Returns the id of the object}
\item{\code{is_valid()}}{
This function implements the HDF5-API function H5Iis_valid.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_IS_VALID} for details.
Additionally, the R-object representing the HDF5-id can be invalidated as well. In this
case, the class id is set to \code{NA} and \code{is_valid} returns \code{FALSE}.}
\item{\code{message()}}{
Legacy function; currently not used; may be removed}
}}
\author{
Holger Hoefling
}
|
