forked from Novartis/hdf5r
/
H5RefClass-class.html
213 lines (147 loc) · 8.9 KB
/
H5RefClass-class.html
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Base class that tracks the ids and allows for closing an id — H5RefClass-class • hdf5r</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.1/css/all.min.css" integrity="sha256-PbSmjxuVAzJ6FPvNYsrXygfGhNJYyZ2GktDbkMBqQZg=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.1/css/v4-shims.min.css" integrity="sha256-A6jcAdwFD48VMjlI3GDxUd+eCQa7/KWy6G9oe/ovaPA=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Base class that tracks the ids and allows for closing an id — H5RefClass-class" />
<meta property="og:description" content="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" />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">hdf5r</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.3.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/hdf5r.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/hhoeflin/hdf5r">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Base class that tracks the ids and allows for closing an id</h1>
<small class="dont-index">Source: <a href='https://github.com/hhoeflin/hdf5r/blob/master/R/R6Classes.R'><code>R/R6Classes.R</code></a></small>
<div class="hidden name"><code>H5RefClass-class.Rd</code></div>
</div>
<div class="ref-description">
<p>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</p>
</div>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>Object of reference class <code>H5RefClass</code>.</p>
<h2 class="hasAnchor" id="fields"><a class="anchor" href="#fields"></a>Fields</h2>
<dl class='dl-horizontal'>
<dt><code>id</code></dt><dd><p>Returns the id of the object as an integer</p></dd>
</dl>
<h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>
<dl class='dl-horizontal'>
<dt><code>new(id = NULL)</code></dt><dd><p>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.</p></dd>
<dt><code><a href='https://rdrr.io/r/base/connections.html'>close()</a></code></dt><dd><p>Closes an object and calls the appropriate HDF5 function for the type of object</p></dd>
<dt><code><a href='https://rdrr.io/r/base/print.html'>print(...)</a></code></dt><dd><p>Prints the class of the object and the id</p></dd>
<dt><code><a href='https://rdrr.io/r/utils/methods.html'>methods()</a></code></dt><dd><p>Prints available methods on the screen</p></dd>
<dt><code>get_file_id()</code></dt><dd><p>This function implements the HDF5-API function H5Iget_file_id.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_GET_FILE_ID'>https://portal.hdfgroup.org/display/HDF5/H5I_GET_FILE_ID</a> for details.</p></dd>
<dt><code>get_obj_type()</code></dt><dd><p>This function implements the HDF5-API function H5Iget_type.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_GET_TYPE'>https://portal.hdfgroup.org/display/HDF5/H5I_GET_TYPE</a> for details.</p></dd>
<dt><code>get_ref()</code></dt><dd><p>This function implements the HDF5-API function H5Iget_ref.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_GET_REF'>https://portal.hdfgroup.org/display/HDF5/H5I_GET_REF</a> for details.</p></dd>
<dt><code>inc_ref()</code></dt><dd><p>This function implements the HDF5-API function H5Iinc_ref.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_INC_REF'>https://portal.hdfgroup.org/display/HDF5/H5I_INC_REF</a> for details.</p></dd>
<dt><code>dec_ref()</code></dt><dd><p>This function implements the HDF5-API function H5Idec_ref.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_DEC_REF'>https://portal.hdfgroup.org/display/HDF5/H5I_DEC_REF</a> for details.</p></dd>
<dt><code>id()</code></dt><dd><p>Returns the id of the object</p></dd>
<dt><code>is_valid()</code></dt><dd><p>This function implements the HDF5-API function H5Iis_valid.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5I_IS_VALID'>https://portal.hdfgroup.org/display/HDF5/H5I_IS_VALID</a> 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</code> and <code>is_valid</code> returns <code>FALSE</code>.</p></dd>
<dt><code><a href='https://rdrr.io/r/base/message.html'>message()</a></code></dt><dd><p>Legacy function; currently not used; may be removed</p></dd>
</dl>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#value">Value</a></li>
<li><a href="#fields">Fields</a></li>
<li><a href="#methods">Methods</a></li>
</ul>
<h2>Author</h2>
<p>Holger Hoefling</p>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Holger Hoefling, Mario Annau.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.9000.</p>
</div>
</footer>
</div>
</body>
</html>