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
|
<!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: H5Group.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">H5Group.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 __H5Group_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __H5Group_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">#ifndef H5_NO_NAMESPACE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="keyword">namespace </span>H5 {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_h5_1_1_group.html"> 29</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_group.html">Group</a> : <span class="keyword">public</span> <a class="code" href="class_h5_1_1_h5_object.html">H5Object</a>, <span class="keyword">public</span> <a class="code" href="class_h5_1_1_common_f_g.html">CommonFG</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// Close this group.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> close();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_h5_1_1_group.html#a0a3a509560218065c0b346c46148f4ca"> 35</a></span>  <span class="keyword">virtual</span> H5std_string <a class="code" href="class_h5_1_1_group.html#a0a3a509560218065c0b346c46148f4ca">fromClass</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(<span class="stringliteral">"Group"</span>); }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Throw group exception.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> throwException(<span class="keyword">const</span> H5std_string& func_name, <span class="keyword">const</span> H5std_string& msg) <span class="keyword">const</span>;</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>  <span class="comment">// for CommonFG to get the file id.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> hid_t getLocId() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Creates a group by way of dereference.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="class_h5_1_1_group.html">Group</a>(<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="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="class_h5_1_1_group.html">Group</a>(<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="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// default constructor</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="class_h5_1_1_group.html">Group</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Copy constructor: makes a copy of the original object</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="class_h5_1_1_group.html">Group</a>(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_group.html">Group</a>& original);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// Gets the group id.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> hid_t getId() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Destructor</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_group.html">Group</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// Creates a copy of an existing group using its id.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="class_h5_1_1_group.html">Group</a>( <span class="keyword">const</span> hid_t group_id );</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="keyword">protected</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span> <span class="comment">// Sets the group id.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> p_setId(<span class="keyword">const</span> hid_t new_id);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif // DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  hid_t id; <span class="comment">// HDF5 group id</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __H5Group_H</span></div>
<div class="ttc" id="class_h5_1_1_group_html"><div class="ttname"><a href="class_h5_1_1_group.html">H5::Group</a></div><div class="ttdoc">Class Group represents an HDF5 group. </div><div class="ttdef"><b>Definition:</b> H5Group.h:29</div></div>
<div class="ttc" id="class_h5_1_1_group_html_a0a3a509560218065c0b346c46148f4ca"><div class="ttname"><a href="class_h5_1_1_group.html#a0a3a509560218065c0b346c46148f4ca">H5::Group::fromClass</a></div><div class="ttdeci">virtual H5std_string fromClass() const </div><div class="ttdoc">Returns this class name. </div><div class="ttdef"><b>Definition:</b> H5Group.h:35</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_h5_object_html"><div class="ttname"><a href="class_h5_1_1_h5_object.html">H5::H5Object</a></div><div class="ttdoc">Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. </div><div class="ttdef"><b>Definition:</b> H5Object.h:47</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_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_common_f_g_html"><div class="ttname"><a href="class_h5_1_1_common_f_g.html">H5::CommonFG</a></div><div class="ttdoc">CommonFG is an abstract base class of H5File and H5Group. </div><div class="ttdef"><b>Definition:</b> H5CommonFG.h:34</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>
|
