diff options
Diffstat (limited to 'c++/src/cpplus_RM/_h5_common_f_g_8h_source.html')
| -rw-r--r-- | c++/src/cpplus_RM/_h5_common_f_g_8h_source.html | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/c++/src/cpplus_RM/_h5_common_f_g_8h_source.html b/c++/src/cpplus_RM/_h5_common_f_g_8h_source.html new file mode 100644 index 0000000..39da81d --- /dev/null +++ b/c++/src/cpplus_RM/_h5_common_f_g_8h_source.html @@ -0,0 +1,268 @@ +<!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: H5CommonFG.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">H5CommonFG.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 __CommonFG_H</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __CommonFG_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>Group;</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>H5File;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>ArrayType;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>VarLenType;</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_h5_1_1_common_f_g.html"> 34</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_common_f_g.html">CommonFG</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"> 36</span>  <span class="comment">// Creates a new group at this location which can be a file</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// or another group.</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="class_h5_1_1_group.html">Group</a> createGroup(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">size_t</span> size_hint = 0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="class_h5_1_1_group.html">Group</a> createGroup(<span class="keyword">const</span> H5std_string& name, <span class="keywordtype">size_t</span> size_hint = 0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Opens an existing group in a location which can be a file</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// or another group.</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="class_h5_1_1_group.html">Group</a> openGroup(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</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> openGroup(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// Creates a new dataset at this location.</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="class_h5_1_1_data_set.html">DataSet</a> createDataSet(<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>& data_type, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& data_space, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_d_set_creat_prop_list.html">DSetCreatPropList</a>& create_plist = <a class="code" href="class_h5_1_1_d_set_creat_prop_list.html#a20cbed4bc7563f3084af99b77e8cacc5">DSetCreatPropList::DEFAULT</a>) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="class_h5_1_1_data_set.html">DataSet</a> createDataSet(<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>& data_type, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a>& data_space, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_d_set_creat_prop_list.html">DSetCreatPropList</a>& create_plist = <a class="code" href="class_h5_1_1_d_set_creat_prop_list.html#a20cbed4bc7563f3084af99b77e8cacc5">DSetCreatPropList::DEFAULT</a>) <span class="keyword">const</span>;</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">// Opens an existing dataset at this location.</span></div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="class_h5_1_1_data_set.html">DataSet</a> openDataSet(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <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_data_set.html">DataSet</a> openDataSet(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Returns the value of a symbolic link.</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  H5std_string getLinkval(<span class="keyword">const</span> <span class="keywordtype">char</span>* link_name, <span class="keywordtype">size_t</span> size=0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  H5std_string getLinkval(<span class="keyword">const</span> H5std_string& link_name, <span class="keywordtype">size_t</span> size=0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// Returns the number of objects in this group.</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  hsize_t getNumObjs() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Retrieves the name of an object in this group, given the</span></div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// object's index.</span></div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  H5std_string getObjnameByIdx(hsize_t idx) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ssize_t getObjnameByIdx(hsize_t idx, <span class="keywordtype">char</span>* name, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ssize_t getObjnameByIdx(hsize_t idx, H5std_string& name, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Retrieves the type of an object in this file or group, given the</span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// object's name</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  H5O_type_t childObjType(<span class="keyword">const</span> H5std_string& objname) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  H5O_type_t childObjType(<span class="keyword">const</span> <span class="keywordtype">char</span>* objname) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  H5O_type_t childObjType(hsize_t index, H5_index_t index_type=H5_INDEX_NAME, H5_iter_order_t order=H5_ITER_INC, <span class="keyword">const</span> <span class="keywordtype">char</span>* objname=<span class="stringliteral">"."</span>) <span class="keyword">const</span>;</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="preprocessor">#ifndef H5_NO_DEPRECATED_SYMBOLS</span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span> <span class="comment">// Returns the type of an object in this group, given the</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// object's index.</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  H5G_obj_t getObjTypeByIdx(hsize_t idx) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  H5G_obj_t getObjTypeByIdx(hsize_t idx, <span class="keywordtype">char</span>* type_name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  H5G_obj_t getObjTypeByIdx(hsize_t idx, H5std_string& type_name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Returns information about an HDF5 object, given by its name,</span></div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// at this location.</span></div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> getObjinfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, hbool_t follow_link, H5G_stat_t& statbuf) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> getObjinfo(<span class="keyword">const</span> H5std_string& name, hbool_t follow_link, H5G_stat_t& statbuf) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> getObjinfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, H5G_stat_t& statbuf) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> getObjinfo(<span class="keyword">const</span> H5std_string& name, H5G_stat_t& statbuf) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// Iterates over the elements of this group - not implemented in</span></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// C++ style yet.</span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> iterateElems(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">int</span> *idx, H5G_iterate_t op, <span class="keywordtype">void</span> *op_data);</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">int</span> iterateElems(<span class="keyword">const</span> H5std_string& name, <span class="keywordtype">int</span> *idx, H5G_iterate_t op, <span class="keywordtype">void</span> *op_data);</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif </span><span class="comment">/* H5_NO_DEPRECATED_SYMBOLS */</span><span class="preprocessor"></span></div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// Creates a link of the specified type from new_name to current_name;</span></div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// both names are interpreted relative to the specified location id.</span></div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> link(H5L_type_t link_type, <span class="keyword">const</span> <span class="keywordtype">char</span>* curr_name, <span class="keyword">const</span> <span class="keywordtype">char</span>* new_name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> link(H5L_type_t link_type, <span class="keyword">const</span> H5std_string& curr_name, <span class="keyword">const</span> H5std_string& new_name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// Removes the specified name at this location.</span></div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> unlink(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> unlink(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// Mounts the file 'child' onto this location.</span></div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> mount(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_h5_file.html">H5File</a>& child, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> mount(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="class_h5_1_1_h5_file.html">H5File</a>& child, <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist) <span class="keyword">const</span>; <span class="comment">// backward compatibility</span></div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> mount(<span class="keyword">const</span> H5std_string& name, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_h5_file.html">H5File</a>& child, <span class="keyword">const</span> <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">void</span> mount(<span class="keyword">const</span> H5std_string& name, <a class="code" href="class_h5_1_1_h5_file.html">H5File</a>& child, <a class="code" href="class_h5_1_1_prop_list.html">PropList</a>& plist) <span class="keyword">const</span>; <span class="comment">// backward compatibility</span></div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// Unmounts the file named 'name' from this parent location.</span></div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> unmount(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> unmount(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// Renames an object at this location.</span></div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> move(<span class="keyword">const</span> <span class="keywordtype">char</span>* src, <span class="keyword">const</span> <span class="keywordtype">char</span>* dst) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> move(<span class="keyword">const</span> H5std_string& src, <span class="keyword">const</span> H5std_string& dst) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// Opens a generic named datatype in this location.</span></div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="class_h5_1_1_data_type.html">DataType</a> openDataType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="class_h5_1_1_data_type.html">DataType</a> openDataType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> +<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment">// Opens a named array datatype in this location.</span></div> +<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="class_h5_1_1_array_type.html">ArrayType</a> openArrayType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="class_h5_1_1_array_type.html">ArrayType</a> openArrayType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> +<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="comment">// Opens a named compound datatype in this location.</span></div> +<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="class_h5_1_1_comp_type.html">CompType</a> openCompType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="class_h5_1_1_comp_type.html">CompType</a> openCompType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// Opens a named enumeration datatype in this location.</span></div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a> openEnumType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a> openEnumType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">// Opens a named integer datatype in this location.</span></div> +<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="class_h5_1_1_int_type.html">IntType</a> openIntType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="class_h5_1_1_int_type.html">IntType</a> openIntType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div> +<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">// Opens a named floating-point datatype in this location.</span></div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="class_h5_1_1_float_type.html">FloatType</a> openFloatType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="class_h5_1_1_float_type.html">FloatType</a> openFloatType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> +<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// Opens a named string datatype in this location.</span></div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="class_h5_1_1_str_type.html">StrType</a> openStrType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="class_h5_1_1_str_type.html">StrType</a> openStrType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</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">// Opens a named variable length datatype in this location.</span></div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="class_h5_1_1_var_len_type.html">VarLenType</a> openVarLenType(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="class_h5_1_1_var_len_type.html">VarLenType</a> openVarLenType(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div> +<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor"></span> <span class="keyword">virtual</span> hid_t getLocId() <span class="keyword">const</span> = 0;</div> +<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> +<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div> +<div class="line"><a name="l00155"></a><span class="lineno"> 155</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> = 0;</div> +<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// Default constructor.</span></div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="class_h5_1_1_common_f_g.html">CommonFG</a>();</div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div> +<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// Noop destructor.</span></div> +<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_common_f_g.html">CommonFG</a>();</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">// end of CommonFG declaration</span></div> +<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div> +<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div> +<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor"></span>}</div> +<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __CommonFG_H</span></div> +<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor"></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_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_d_set_creat_prop_list_html"><div class="ttname"><a href="class_h5_1_1_d_set_creat_prop_list.html">H5::DSetCreatPropList</a></div><div class="ttdoc">Class DSetCreatPropList represents the dataset creation property list. </div><div class="ttdef"><b>Definition:</b> H5DcreatProp.h:28</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_data_set_html"><div class="ttname"><a href="class_h5_1_1_data_set.html">H5::DataSet</a></div><div class="ttdoc">Class DataSet operates on HDF5 datasets. </div><div class="ttdef"><b>Definition:</b> H5DataSet.h:31</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_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_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_d_set_creat_prop_list_html_a20cbed4bc7563f3084af99b77e8cacc5"><div class="ttname"><a href="class_h5_1_1_d_set_creat_prop_list.html#a20cbed4bc7563f3084af99b77e8cacc5">H5::DSetCreatPropList::DEFAULT</a></div><div class="ttdeci">static const DSetCreatPropList DEFAULT</div><div class="ttdoc">Constant for dataset creation default property. </div><div class="ttdef"><b>Definition:</b> H5DcreatProp.h:31</div></div> +<div class="ttc" id="class_h5_1_1_h5_file_html"><div class="ttname"><a href="class_h5_1_1_h5_file.html">H5::H5File</a></div><div class="ttdoc">Class H5File represents an HDF5 file. </div><div class="ttdef"><b>Definition:</b> H5File.h:29</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 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> |