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
|
<!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.8.5"/>
<title>HDF5 C++ API: H5Location.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<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="hdf_logo.jpg"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">HDF5 C++ API
 <span id="projectnumber">1.8.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">H5Location.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// C++ informative line for the emacs editor: -*- C++ -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright by The HDF Group. *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright by the Board of Trustees of the University of Illinois. *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * All rights reserved. *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This file is part of HDF5. The full HDF5 copyright notice, including *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * terms governing use, modification, and redistribution, is contained in *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the files COPYING and Copyright.html. COPYING can be found at the root *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * of the source code distribution tree; Copyright.html can be found at the *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * root level of an installed copy of the electronic HDF5 document set and *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * is linked from the top-level documents page. It can also be found at *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * access to either file, you may request a copy from help@hdfgroup.org. *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __H5Location_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __H5Location_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "H5Classes.h"</span> <span class="comment">// constains forward class declarations</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="keyword">namespace </span>H5 {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespace_h5.html#a96d8e144995c506ad2ad38f51c66e5f6"> 26</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>; <span class="comment">// forward declaration for UserData4Aiterate</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Define the operator function pointer for H5Aiterate().</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespace_h5.html#a5913cae82307d2db03277d081dd71b26"> 29</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="namespace_h5.html#a5913cae82307d2db03277d081dd71b26">attr_operator_t</a>)( <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>& loc<span class="comment">/*in*/</span>,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">const</span> H5std_string attr_name<span class="comment">/*in*/</span>,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> *operator_data<span class="comment">/*in,out*/</span>);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_h5_1_1_user_data4_aiterate.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="class_h5_1_1_user_data4_aiterate.html">UserData4Aiterate</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_h5_1_1_user_data4_aiterate.html#adc317bc595aa58e76e24a11f43367d13"> 36</a></span>  <a class="code" href="namespace_h5.html#a5913cae82307d2db03277d081dd71b26">attr_operator_t</a> <a class="code" href="class_h5_1_1_user_data4_aiterate.html#adc317bc595aa58e76e24a11f43367d13">op</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_h5_1_1_user_data4_aiterate.html#a3aa5ddcad106d950c7eb0932a25fccb2"> 37</a></span>  <span class="keywordtype">void</span>* <a class="code" href="class_h5_1_1_user_data4_aiterate.html#a3aa5ddcad106d950c7eb0932a25fccb2">opData</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_h5_1_1_user_data4_aiterate.html#a19aaf90cba18d5927bf8d7b216cbde21"> 38</a></span>  <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>* <a class="code" href="class_h5_1_1_user_data4_aiterate.html#a19aaf90cba18d5927bf8d7b216cbde21">location</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Most of these methods were in H5Object but are now moved here because</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// a location can be a file, group, dataset, or named datatype. -BMR, 2013-10-1</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_h5_1_1_h5_location.html"> 50</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a> : <span class="keyword">public</span> <a class="code" href="class_h5_1_1_id_component.html">IdComponent</a> {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Creates an attribute for the specified object at this location</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// PropList is currently not used, so always be default.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> createAttribute( <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& space, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& create_plist = <a class="code" href="class_h5_1_1_prop_list.html#a0f2f757ca782a743006c5756191c404b">PropList::DEFAULT</a> ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> createAttribute( <span class="keyword">const</span> H5std_string& name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& space, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& create_plist = <a class="code" href="class_h5_1_1_prop_list.html#a0f2f757ca782a743006c5756191c404b">PropList::DEFAULT</a> ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Given its name, opens the attribute that belongs to an object at</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// this location.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> openAttribute( <span class="keyword">const</span> <span class="keywordtype">char</span>* name ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> openAttribute( <span class="keyword">const</span> H5std_string& name ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Given its index, opens the attribute that belongs to an object at</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// this location.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> openAttribute( <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> idx ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// Flushes all buffers associated with this location to disk.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> flush( H5F_scope_t scope ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// Gets the name of the file, specified by this location.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  H5std_string getFileName() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// Determines the number of attributes at this location.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">int</span> getNumAttrs() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#ifndef H5_NO_DEPRECATED_SYMBOLS</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span> <span class="comment">// Retrieves the type of object that an object reference points to.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  H5G_obj_t getObjType(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif </span><span class="comment">/* H5_NO_DEPRECATED_SYMBOLS */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Retrieves the type of object that an object reference points to.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  H5O_type_t getRefObjType(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Note: getRefObjType deprecates getObjType, but getObjType's name is</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// misleading, so getRefObjType is used in the new function instead.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// Iterate user's function over the attributes at this location.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">int</span> iterateAttrs(<a class="code" href="namespace_h5.html#a5913cae82307d2db03277d081dd71b26">attr_operator_t</a> user_op, <span class="keywordtype">unsigned</span>* idx = NULL, <span class="keywordtype">void</span>* op_data = NULL);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// Checks whether the named attribute exists at this location.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> attrExists(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> attrExists(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// Renames the named attribute to a new name.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> renameAttr(<span class="keyword">const</span> <span class="keywordtype">char</span>* oldname, <span class="keyword">const</span> <span class="keywordtype">char</span>* newname) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> renameAttr(<span class="keyword">const</span> H5std_string& oldname, <span class="keyword">const</span> H5std_string& newname) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// Removes the named attribute from this location.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> removeAttr(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> removeAttr(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// Sets the comment for an HDF5 object specified by its name.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> setComment(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* comment) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> setComment(<span class="keyword">const</span> H5std_string& name, <span class="keyword">const</span> H5std_string& comment) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> setComment(<span class="keyword">const</span> <span class="keywordtype">char</span>* comment) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> setComment(<span class="keyword">const</span> H5std_string& comment) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// Retrieves comment for the HDF5 object specified by its name.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  ssize_t getComment(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">size_t</span> buf_size, <span class="keywordtype">char</span>* comment) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  H5std_string getComment(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">size_t</span> buf_size=0) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  H5std_string getComment(<span class="keyword">const</span> H5std_string& name, <span class="keywordtype">size_t</span> buf_size=0) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// Removes the comment for the HDF5 object specified by its name.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">void</span> removeComment(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> removeComment(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// Creates a reference to a named object or to a dataset region</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// in this object.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> reference(<span class="keywordtype">void</span>* ref, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> reference(<span class="keywordtype">void</span>* ref, <span class="keyword">const</span> H5std_string& name,</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> reference(<span class="keywordtype">void</span>* ref, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& dataspace,</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> reference(<span class="keywordtype">void</span>* ref, <span class="keyword">const</span> H5std_string& name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& dataspace,</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="comment">// Open a referenced object whose location is specified by either</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// a file, an HDF5 object, or an attribute.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> dereference(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>& loc, <span class="keyword">const</span> <span class="keywordtype">void</span>* ref, H5R_type_t ref_type = H5R_OBJECT, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist = <a class="code" href="class_h5_1_1_prop_list.html#a0f2f757ca782a743006c5756191c404b">PropList::DEFAULT</a>);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> dereference(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_attribute.html">Attribute</a>& attr, <span class="keyword">const</span> <span class="keywordtype">void</span>* ref, H5R_type_t ref_type = H5R_OBJECT, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist = <a class="code" href="class_h5_1_1_prop_list.html#a0f2f757ca782a743006c5756191c404b">PropList::DEFAULT</a>);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// Retrieves a dataspace with the region pointed to selected.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a> getRegion(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">virtual</span> hid_t getId() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="comment">// Default constructor</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="namespace_h5.html#a96d8e144995c506ad2ad38f51c66e5f6">H5Location</a>();</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// Creates a copy of an existing object giving the location id.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="namespace_h5.html#a96d8e144995c506ad2ad38f51c66e5f6">H5Location</a>(<span class="keyword">const</span> hid_t loc_id);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// Copy constructor.</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="namespace_h5.html#a96d8e144995c506ad2ad38f51c66e5f6">H5Location</a>(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>& original);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"></span> <span class="comment">// Creates a reference to an HDF5 object or a dataset region.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">void</span> p_reference(<span class="keywordtype">void</span>* ref, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, hid_t space_id, H5R_type_t ref_type) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// Dereferences a ref into an HDF5 id.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  hid_t p_dereference(hid_t loc_id, <span class="keyword">const</span> <span class="keywordtype">void</span>* ref, H5R_type_t ref_type, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist, <span class="keyword">const</span> <span class="keywordtype">char</span>* from_func);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#ifndef H5_NO_DEPRECATED_SYMBOLS</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor"></span> <span class="comment">// Retrieves the type of object that an object reference points to.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  H5G_obj_t p_get_obj_type(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif </span><span class="comment">/* H5_NO_DEPRECATED_SYMBOLS */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// Retrieves the type of object that an object reference points to.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  H5O_type_t p_get_ref_obj_type(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#endif // DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="comment">// Noop destructor.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_h5_location.html">H5Location</a>();</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> }; <span class="comment">/* end class H5Location */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __H5Location_H</span></div>
<div class="ttc" id="class_h5_1_1_id_component_html"><div class="ttname"><a href="class_h5_1_1_id_component.html">H5::IdComponent</a></div><div class="ttdoc">Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. </div><div class="ttdef"><b>Definition:</b> H5IdComponent.h:32</div></div>
<div class="ttc" id="class_h5_1_1_data_space_html"><div class="ttname"><a href="class_h5_1_1_data_space.html">H5::DataSpace</a></div><div class="ttdoc">Class DataSpace operates on HDF5 dataspaces. </div><div class="ttdef"><b>Definition:</b> H5DataSpace.h:25</div></div>
<div class="ttc" id="class_h5_1_1_attribute_html"><div class="ttname"><a href="class_h5_1_1_attribute.html">H5::Attribute</a></div><div class="ttdoc">Class Attribute operates on HDF5 attributes. </div><div class="ttdef"><b>Definition:</b> H5Attribute.h:32</div></div>
<div class="ttc" id="class_h5_1_1_data_type_html"><div class="ttname"><a href="class_h5_1_1_data_type.html">H5::DataType</a></div><div class="ttdoc">Class DataType provides generic operations on HDF5 datatypes. </div><div class="ttdef"><b>Definition:</b> H5DataType.h:31</div></div>
<div class="ttc" id="namespace_h5_html_a96d8e144995c506ad2ad38f51c66e5f6"><div class="ttname"><a href="namespace_h5.html#a96d8e144995c506ad2ad38f51c66e5f6">H5::H5Location</a></div><div class="ttdeci">class H5_DLLCPP H5Location</div><div class="ttdef"><b>Definition:</b> H5Location.h:26</div></div>
<div class="ttc" id="class_h5_1_1_h5_location_html"><div class="ttname"><a href="class_h5_1_1_h5_location.html">H5::H5Location</a></div><div class="ttdoc">H5Location is an abstract base class, added in version 1.8.12. </div><div class="ttdef"><b>Definition:</b> H5Location.h:50</div></div>
<div class="ttc" id="class_h5_1_1_user_data4_aiterate_html_a3aa5ddcad106d950c7eb0932a25fccb2"><div class="ttname"><a href="class_h5_1_1_user_data4_aiterate.html#a3aa5ddcad106d950c7eb0932a25fccb2">H5::UserData4Aiterate::opData</a></div><div class="ttdeci">void * opData</div><div class="ttdef"><b>Definition:</b> H5Location.h:37</div></div>
<div class="ttc" id="namespace_h5_html_a5913cae82307d2db03277d081dd71b26"><div class="ttname"><a href="namespace_h5.html#a5913cae82307d2db03277d081dd71b26">H5::attr_operator_t</a></div><div class="ttdeci">void(* attr_operator_t)(H5Location &loc, const H5std_string attr_name, void *operator_data)</div><div class="ttdef"><b>Definition:</b> H5Location.h:29</div></div>
<div class="ttc" id="class_h5_1_1_user_data4_aiterate_html_a19aaf90cba18d5927bf8d7b216cbde21"><div class="ttname"><a href="class_h5_1_1_user_data4_aiterate.html#a19aaf90cba18d5927bf8d7b216cbde21">H5::UserData4Aiterate::location</a></div><div class="ttdeci">H5Location * location</div><div class="ttdef"><b>Definition:</b> H5Location.h:38</div></div>
<div class="ttc" id="class_h5_1_1_prop_list_html"><div class="ttname"><a href="class_h5_1_1_prop_list.html">H5::PropList</a></div><div class="ttdoc">Class PropList provides operations for generic property lists. </div><div class="ttdef"><b>Definition:</b> H5PropList.h:25</div></div>
<div class="ttc" id="class_h5_1_1_prop_list_html_a0f2f757ca782a743006c5756191c404b"><div class="ttname"><a href="class_h5_1_1_prop_list.html#a0f2f757ca782a743006c5756191c404b">H5::PropList::DEFAULT</a></div><div class="ttdeci">static const PropList DEFAULT</div><div class="ttdoc">Constant for default property. </div><div class="ttdef"><b>Definition:</b> H5PropList.h:28</div></div>
<div class="ttc" id="class_h5_1_1_user_data4_aiterate_html"><div class="ttname"><a href="class_h5_1_1_user_data4_aiterate.html">H5::UserData4Aiterate</a></div><div class="ttdoc">User data for attribute iteration. </div><div class="ttdef"><b>Definition:</b> H5Location.h:34</div></div>
<div class="ttc" id="class_h5_1_1_user_data4_aiterate_html_adc317bc595aa58e76e24a11f43367d13"><div class="ttname"><a href="class_h5_1_1_user_data4_aiterate.html#adc317bc595aa58e76e24a11f43367d13">H5::UserData4Aiterate::op</a></div><div class="ttdeci">attr_operator_t op</div><div class="ttdef"><b>Definition:</b> H5Location.h:36</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jul 21 2014 10:58:44 for HDF5 C++ API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|
