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
|
<!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: H5AbstractDs.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">H5AbstractDs.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 __AbstractDs_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __AbstractDs_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="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span>ArrayType;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>CompType;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>EnumType;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>FloatType;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span>IntType;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>StrType;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>VarLenType;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_h5_1_1_abstract_ds.html"> 39</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Gets a copy the datatype of that this abstract dataset uses.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Note that this datatype is a generic one and can only be accessed</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// via generic member functions, i.e., member functions belong</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// to DataType. To get specific datatype, i.e. EnumType, FloatType,</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// etc..., use the specific functions, that follow, instead.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_h5_1_1_data_type.html">DataType</a> getDataType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Gets a copy of the specific datatype of this abstract dataset.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="class_h5_1_1_array_type.html">ArrayType</a> getArrayType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="class_h5_1_1_comp_type.html">CompType</a> getCompType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a> getEnumType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="class_h5_1_1_int_type.html">IntType</a> getIntType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="class_h5_1_1_float_type.html">FloatType</a> getFloatType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="class_h5_1_1_str_type.html">StrType</a> getStrType() <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_var_len_type.html">VarLenType</a> getVarLenType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getInMemDataSize() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a> getSpace() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Gets the class of the datatype that is used by this abstract</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// dataset.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  H5T_class_t getTypeClass() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> hsize_t getStorageSize() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> H5std_string fromClass() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Copy constructor</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>& original );</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Destructor</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Default constructor</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Constructor that takes an attribute id or a dataset id.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>( <span class="keyword">const</span> hid_t ds_id );</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// This member function is implemented by DataSet and Attribute.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> hid_t p_get_type() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __AbstractDs_H</span></div>
<div class="ttc" id="class_h5_1_1_enum_type_html"><div class="ttname"><a href="class_h5_1_1_enum_type.html">H5::EnumType</a></div><div class="ttdoc">Class EnumType operates on HDF5 enum datatypes. </div><div class="ttdef"><b>Definition:</b> H5EnumType.h:25</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_int_type_html"><div class="ttname"><a href="class_h5_1_1_int_type.html">H5::IntType</a></div><div class="ttdoc">Class IntType operates on HDF5 integer datatype. </div><div class="ttdef"><b>Definition:</b> H5IntType.h:25</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="class_h5_1_1_var_len_type_html"><div class="ttname"><a href="class_h5_1_1_var_len_type.html">H5::VarLenType</a></div><div class="ttdoc">VarLenType operates on the HDF5 C&#39;s Variable-length Datatypes. </div><div class="ttdef"><b>Definition:</b> H5VarLenType.h:25</div></div>
<div class="ttc" id="class_h5_1_1_abstract_ds_html"><div class="ttname"><a href="class_h5_1_1_abstract_ds.html">H5::AbstractDs</a></div><div class="ttdoc">AbstractDs is an abstract base class, inherited by Attribute and DataSet. </div><div class="ttdef"><b>Definition:</b> H5AbstractDs.h:39</div></div>
<div class="ttc" id="class_h5_1_1_array_type_html"><div class="ttname"><a href="class_h5_1_1_array_type.html">H5::ArrayType</a></div><div class="ttdoc">Class ArrayType inherits from DataType and provides wrappers for the HDF5&#39;s Array Datatypes...</div><div class="ttdef"><b>Definition:</b> H5ArrayType.h:28</div></div>
<div class="ttc" id="class_h5_1_1_float_type_html"><div class="ttname"><a href="class_h5_1_1_float_type.html">H5::FloatType</a></div><div class="ttdoc">Class FloatType operates on HDF5 floating point datatype. </div><div class="ttdef"><b>Definition:</b> H5FloatType.h:25</div></div>
<div class="ttc" id="class_h5_1_1_str_type_html"><div class="ttname"><a href="class_h5_1_1_str_type.html">H5::StrType</a></div><div class="ttdoc">Class StrType operates on HDF5 string datatypes. </div><div class="ttdef"><b>Definition:</b> H5StrType.h:25</div></div>
<div class="ttc" id="class_h5_1_1_comp_type_html"><div class="ttname"><a href="class_h5_1_1_comp_type.html">H5::CompType</a></div><div class="ttdoc">CompType is a derivative of a DataType and operates on HDF5 compound datatypes. </div><div class="ttdef"><b>Definition:</b> H5CompType.h:28</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>
|
