diff options
Diffstat (limited to 'c++/src/cpplus_RM/_h5_library_8h_source.html')
| -rw-r--r-- | c++/src/cpplus_RM/_h5_library_8h_source.html | 161 |
1 files changed, 0 insertions, 161 deletions
diff --git a/c++/src/cpplus_RM/_h5_library_8h_source.html b/c++/src/cpplus_RM/_h5_library_8h_source.html deleted file mode 100644 index 7c19562..0000000 --- a/c++/src/cpplus_RM/_h5_library_8h_source.html +++ /dev/null @@ -1,161 +0,0 @@ -<!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: H5Library.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">H5Library.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 __H5Library_H</span></div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __H5Library_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="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div> -<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define NOTATEXIT (-10) // just in case the HDF5 library use more</span></div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span> <span class="comment">// negative constants. Note: the solution used for the atexit/global</span></div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// destructors is not reliable, and desperately needs improvement</span></div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// It is not even working, inifiteloop message still printed when</span></div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// calling H5close</span></div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif // DOXYGEN_SHOULD_SKIP_THIS</span></div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span></div> -<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_h5_1_1_h5_library.html"> 38</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_h5_library.html">H5Library</a> {</div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div> -<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> need_cleanup; <span class="comment">// indicates if H5close should be called</span></div> -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif // DOXYGEN_SHOULD_SKIP_THIS</span></div> -<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span></div> -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Initializes the HDF5 library.</span></div> -<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> open();</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">// Flushes all data to disk, closes files, and cleans up memory.</span></div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> close();</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">// Instructs library not to install atexit cleanup routine</span></div> -<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> dontAtExit();</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">// Returns the HDF library release number.</span></div> -<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> getLibVersion( <span class="keywordtype">unsigned</span>& majnum, <span class="keywordtype">unsigned</span>& minnum, <span class="keywordtype">unsigned</span>& relnum );</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">// Verifies that the arguments match the version numbers compiled</span></div> -<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// into the library</span></div> -<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> checkVersion( <span class="keywordtype">unsigned</span> majnum, <span class="keywordtype">unsigned</span> minnum, <span class="keywordtype">unsigned</span> relnum );</div> -<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> -<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Walks through all the garbage collection routines for the library,</span></div> -<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// which are supposed to free any unused memory they have allocated.</span></div> -<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> garbageCollect();</div> -<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Sets limits on the different kinds of free lists.</span></div> -<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> setFreeListLimits(<span class="keywordtype">int</span> reg_global_lim, <span class="keywordtype">int</span> reg_list_lim, <span class="keywordtype">int</span></div> -<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  arr_global_lim, <span class="keywordtype">int</span> arr_list_lim, <span class="keywordtype">int</span> blk_global_lim, <span class="keywordtype">int</span> blk_list_lim);</div> -<div class="line"><a name="l00067"></a><span class="lineno"> 67</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>  <span class="comment">// Default constructor - no instance ever created</span></div> -<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="class_h5_1_1_h5_library.html">H5Library</a>() {};</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> };</div> -<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div> -<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span>}</div> -<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __H5Library_H</span></div> -<div class="ttc" id="class_h5_1_1_h5_library_html"><div class="ttname"><a href="class_h5_1_1_h5_library.html">H5::H5Library</a></div><div class="ttdoc">Class H5Library operates the HDF5 library globably. </div><div class="ttdef"><b>Definition:</b> H5Library.h:38</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> |