blob: d46e8cf2ea5a0a0697531610698b393bc45971b3 (
plain)
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: H5O_hdr_info_t Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__hdr__info__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">H5O_hdr_info_t Class Reference</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information struct for object header metadata (for H5Oget_info/H5Oget_info_by_name/H5Oget_info_by_idx) </p>
</div><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for H5O_hdr_info_t:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__hdr__info__t.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a39e5bc339e3b5924ec96de42fbb8f33f" id="r_a39e5bc339e3b5924ec96de42fbb8f33f"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="#a39e5bc339e3b5924ec96de42fbb8f33f">equals</a> (Object o)</td></tr>
<tr class="separator:a39e5bc339e3b5924ec96de42fbb8f33f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aad880fc4455c253781e8968f2239d56f" id="r_aad880fc4455c253781e8968f2239d56f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aad880fc4455c253781e8968f2239d56f">version</a></td></tr>
<tr class="separator:aad880fc4455c253781e8968f2239d56f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afef5dd7d4a08252580b343ea0fc765ef" id="r_afef5dd7d4a08252580b343ea0fc765ef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#afef5dd7d4a08252580b343ea0fc765ef">nmesgs</a></td></tr>
<tr class="separator:afef5dd7d4a08252580b343ea0fc765ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c93644a52e79d1dc12c8367b3c1c2bb" id="r_a6c93644a52e79d1dc12c8367b3c1c2bb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c93644a52e79d1dc12c8367b3c1c2bb">nchunks</a></td></tr>
<tr class="separator:a6c93644a52e79d1dc12c8367b3c1c2bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8bf36fe0577cba66bccda3a6f7e80a4" id="r_ac8bf36fe0577cba66bccda3a6f7e80a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8bf36fe0577cba66bccda3a6f7e80a4">flags</a></td></tr>
<tr class="separator:ac8bf36fe0577cba66bccda3a6f7e80a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75934105d9120cebb5137b95fb251333" id="r_a75934105d9120cebb5137b95fb251333"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a75934105d9120cebb5137b95fb251333">space_total</a></td></tr>
<tr class="separator:a75934105d9120cebb5137b95fb251333"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b1bab88b76237682243c46cdb9ad76e" id="r_a8b1bab88b76237682243c46cdb9ad76e"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b1bab88b76237682243c46cdb9ad76e">space_meta</a></td></tr>
<tr class="separator:a8b1bab88b76237682243c46cdb9ad76e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5acdeb4757dc587aacefcb2089920b19" id="r_a5acdeb4757dc587aacefcb2089920b19"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5acdeb4757dc587aacefcb2089920b19">space_mesg</a></td></tr>
<tr class="separator:a5acdeb4757dc587aacefcb2089920b19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c4d9feac6023e3045fbd06d4e33ca20" id="r_a4c4d9feac6023e3045fbd06d4e33ca20"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c4d9feac6023e3045fbd06d4e33ca20">space_free</a></td></tr>
<tr class="separator:a4c4d9feac6023e3045fbd06d4e33ca20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21a92907adc21fe3ab1c1a0623224a18" id="r_a21a92907adc21fe3ab1c1a0623224a18"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a21a92907adc21fe3ab1c1a0623224a18">mesg_present</a></td></tr>
<tr class="separator:a21a92907adc21fe3ab1c1a0623224a18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf82a3d91faae79666ad7983ea8212c7" id="r_aaf82a3d91faae79666ad7983ea8212c7"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf82a3d91faae79666ad7983ea8212c7">mesg_shared</a></td></tr>
<tr class="separator:aaf82a3d91faae79666ad7983ea8212c7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a39e5bc339e3b5924ec96de42fbb8f33f" name="a39e5bc339e3b5924ec96de42fbb8f33f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39e5bc339e3b5924ec96de42fbb8f33f">◆ </a></span>equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean equals </td>
<td>(</td>
<td class="paramtype">Object</td> <td class="paramname"><span class="paramname"><em>o</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="ac8bf36fe0577cba66bccda3a6f7e80a4" name="ac8bf36fe0577cba66bccda3a6f7e80a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8bf36fe0577cba66bccda3a6f7e80a4">◆ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Object header status flags </p>
</div>
</div>
<a id="a21a92907adc21fe3ab1c1a0623224a18" name="a21a92907adc21fe3ab1c1a0623224a18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21a92907adc21fe3ab1c1a0623224a18">◆ </a></span>mesg_present</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long mesg_present</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags to indicate presence of message type in header </p>
</div>
</div>
<a id="aaf82a3d91faae79666ad7983ea8212c7" name="aaf82a3d91faae79666ad7983ea8212c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf82a3d91faae79666ad7983ea8212c7">◆ </a></span>mesg_shared</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long mesg_shared</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags to indicate message type is shared in header </p>
</div>
</div>
<a id="a6c93644a52e79d1dc12c8367b3c1c2bb" name="a6c93644a52e79d1dc12c8367b3c1c2bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c93644a52e79d1dc12c8367b3c1c2bb">◆ </a></span>nchunks</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int nchunks</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of object header chunks </p>
</div>
</div>
<a id="afef5dd7d4a08252580b343ea0fc765ef" name="afef5dd7d4a08252580b343ea0fc765ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afef5dd7d4a08252580b343ea0fc765ef">◆ </a></span>nmesgs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int nmesgs</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of object header messages </p>
</div>
</div>
<a id="a4c4d9feac6023e3045fbd06d4e33ca20" name="a4c4d9feac6023e3045fbd06d4e33ca20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c4d9feac6023e3045fbd06d4e33ca20">◆ </a></span>space_free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long space_free</td>
</tr>
</table>
</div><div class="memdoc">
<p>Free space within object header </p>
</div>
</div>
<a id="a5acdeb4757dc587aacefcb2089920b19" name="a5acdeb4757dc587aacefcb2089920b19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5acdeb4757dc587aacefcb2089920b19">◆ </a></span>space_mesg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long space_mesg</td>
</tr>
</table>
</div><div class="memdoc">
<p>Space within header for actual message information </p>
</div>
</div>
<a id="a8b1bab88b76237682243c46cdb9ad76e" name="a8b1bab88b76237682243c46cdb9ad76e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b1bab88b76237682243c46cdb9ad76e">◆ </a></span>space_meta</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long space_meta</td>
</tr>
</table>
</div><div class="memdoc">
<p>Space within header for object header metadata information </p>
</div>
</div>
<a id="a75934105d9120cebb5137b95fb251333" name="a75934105d9120cebb5137b95fb251333"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75934105d9120cebb5137b95fb251333">◆ </a></span>space_total</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long space_total</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total space for storing object header in file </p>
</div>
</div>
<a id="aad880fc4455c253781e8968f2239d56f" name="aad880fc4455c253781e8968f2239d56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad880fc4455c253781e8968f2239d56f">◆ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version number of header format in file </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>java/src/hdf/hdf5lib/structs/<a class="el" href="_h5_o__hdr__info__t_8java.html">H5O_hdr_info_t.java</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>hdf</b></li><li class="navelem"><a class="el" href="namespacehdf_1_1hdf5lib.html">hdf5lib</a></li><li class="navelem"><a class="el" href="namespacehdf_1_1hdf5lib_1_1structs.html">structs</a></li><li class="navelem"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_o__hdr__info__t.html">H5O_hdr_info_t</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|