c17fb6fa1d
Purpose:
Adding C++ Reference Manual to 1.6 release branch.
This manual is automatically generated
by doxygen from the C++ source code.
Platforms tested:
Mozilla, Safari, IE 5
690 lines
25 KiB
HTML
690 lines
25 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html xmlns:v="urn:schemas-microsoft-com:vml"
|
||
xmlns:o="urn:schemas-microsoft-com:office:office"
|
||
xmlns:w="urn:schemas-microsoft-com:office:word"
|
||
xmlns="http://www.w3.org/TR/REC-html40">
|
||
|
||
<head>
|
||
<meta http-equiv=Content-Type content="text/html; charset=iso-8859-1">
|
||
<meta name=ProgId content=Word.Document>
|
||
<meta name=Generator content="Microsoft Word 10">
|
||
<meta name=Originator content="Microsoft Word 10">
|
||
<link rel=File-List href="header_files/filelist.xml">
|
||
<link rel=Edit-Time-Data href="header_files/editdata.mso">
|
||
<!--[if !mso]>
|
||
<style>
|
||
v\:* {behavior:url(#default#VML);}
|
||
o\:* {behavior:url(#default#VML);}
|
||
w\:* {behavior:url(#default#VML);}
|
||
.shape {behavior:url(#default#VML);}
|
||
</style>
|
||
<![endif]-->
|
||
<title>Main Page</title>
|
||
<!--[if gte mso 9]><xml>
|
||
<o:DocumentProperties>
|
||
<o:Author>Randy Ribler</o:Author>
|
||
<o:Template>Normal</o:Template>
|
||
<o:LastAuthor>Randy Ribler</o:LastAuthor>
|
||
<o:Revision>6</o:Revision>
|
||
<o:TotalTime>16</o:TotalTime>
|
||
<o:Created>2004-07-23T05:34:00Z</o:Created>
|
||
<o:LastSaved>2004-07-23T06:03:00Z</o:LastSaved>
|
||
<o:Pages>1</o:Pages>
|
||
<o:Words>5</o:Words>
|
||
<o:Characters>32</o:Characters>
|
||
<o:Company>LC</o:Company>
|
||
<o:Lines>1</o:Lines>
|
||
<o:Paragraphs>1</o:Paragraphs>
|
||
<o:CharactersWithSpaces>36</o:CharactersWithSpaces>
|
||
<o:Version>10.2625</o:Version>
|
||
</o:DocumentProperties>
|
||
</xml><![endif]--><!--[if gte mso 9]><xml>
|
||
<w:WordDocument>
|
||
<w:SpellingState>Clean</w:SpellingState>
|
||
<w:GrammarState>Clean</w:GrammarState>
|
||
<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
|
||
</w:WordDocument>
|
||
</xml><![endif]-->
|
||
<link rel=Stylesheet type="text/css" media=all href=doxygen.css>
|
||
<style>
|
||
<!--
|
||
/* Style Definitions */
|
||
p.MsoNormal, li.MsoNormal, div.MsoNormal
|
||
{mso-style-parent:"";
|
||
margin:0in;
|
||
margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";
|
||
mso-believe-normal-left:yes;}
|
||
h1
|
||
{mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
text-align:center;
|
||
mso-pagination:widow-orphan;
|
||
mso-outline-level:1;
|
||
font-size:24.0pt;
|
||
font-family:"Times New Roman";
|
||
font-weight:bold;}
|
||
h2
|
||
{mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
mso-pagination:widow-orphan;
|
||
mso-outline-level:2;
|
||
font-size:18.0pt;
|
||
font-family:"Times New Roman";
|
||
font-weight:bold;}
|
||
a:link, span.MsoHyperlink
|
||
{color:#252E78;
|
||
text-decoration:underline;
|
||
text-underline:single;}
|
||
a:visited, span.MsoHyperlinkFollowed
|
||
{color:#3D2185;
|
||
text-decoration:underline;
|
||
text-underline:single;}
|
||
p
|
||
{mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
address
|
||
{margin:0in;
|
||
margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
font-style:italic;}
|
||
pre
|
||
{margin:0in;
|
||
margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
tab-stops:45.8pt 91.6pt 137.4pt 183.2pt 229.0pt 274.8pt 320.6pt 366.4pt 412.2pt 458.0pt 503.8pt 549.6pt 595.4pt 641.2pt 687.0pt 732.8pt;
|
||
font-size:10.0pt;
|
||
font-family:"Courier New";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.formuladsp, li.formuladsp, div.formuladsp
|
||
{mso-style-name:formuladsp;
|
||
mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
text-align:center;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.mdtable, li.mdtable, div.mdtable
|
||
{mso-style-name:mdtable;
|
||
mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
mso-pagination:widow-orphan;
|
||
background:#F4F4FB;
|
||
border:none;
|
||
mso-border-alt:solid #868686 .75pt;
|
||
padding:0in;
|
||
mso-padding-alt:0in 0in 0in 0in;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.mdrow, li.mdrow, div.mdrow
|
||
{mso-style-name:mdrow;
|
||
mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.mdescleft, li.mdescleft, div.mdescleft
|
||
{mso-style-name:mdescleft;
|
||
margin:0in;
|
||
margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
background:#FAFAFA;
|
||
font-size:10.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";
|
||
font-style:italic;}
|
||
p.mdescright, li.mdescright, div.mdescright
|
||
{mso-style-name:mdescright;
|
||
margin:0in;
|
||
margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
background:#FAFAFA;
|
||
font-size:10.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";
|
||
font-style:italic;}
|
||
p.memitemleft, li.memitemleft, div.memitemleft
|
||
{mso-style-name:memitemleft;
|
||
margin:3.0pt;
|
||
mso-pagination:widow-orphan;
|
||
background:#FAFAFA;
|
||
border:none;
|
||
mso-border-top-alt:solid #E0E0E0 .75pt;
|
||
padding:0in;
|
||
mso-padding-alt:1.0pt 0in 0in 0in;
|
||
font-size:9.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.memitemright, li.memitemright, div.memitemright
|
||
{mso-style-name:memitemright;
|
||
margin:3.0pt;
|
||
mso-pagination:widow-orphan;
|
||
background:#FAFAFA;
|
||
border:none;
|
||
mso-border-top-alt:solid #E0E0E0 .75pt;
|
||
padding:0in;
|
||
mso-padding-alt:1.0pt 0in 0in 0in;
|
||
font-size:10.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";}
|
||
p.search, li.search, div.search
|
||
{mso-style-name:search;
|
||
mso-margin-top-alt:auto;
|
||
margin-right:0in;
|
||
mso-margin-bottom-alt:auto;
|
||
margin-left:0in;
|
||
mso-pagination:widow-orphan;
|
||
font-size:12.0pt;
|
||
font-family:"Times New Roman";
|
||
mso-fareast-font-family:"Times New Roman";
|
||
font-weight:bold;}
|
||
@page Section1
|
||
{size:8.5in 11.0in;
|
||
margin:1.0in 1.25in 1.0in 1.25in;
|
||
mso-header-margin:.5in;
|
||
mso-footer-margin:.5in;
|
||
mso-paper-source:0;}
|
||
div.Section1
|
||
{page:Section1;}
|
||
-->
|
||
</style>
|
||
<!--[if gte mso 10]>
|
||
<style>
|
||
/* Style Definitions */
|
||
table.MsoNormalTable
|
||
{mso-style-name:"Table Normal";
|
||
mso-tstyle-rowband-size:0;
|
||
mso-tstyle-colband-size:0;
|
||
mso-style-noshow:yes;
|
||
mso-style-parent:"";
|
||
mso-padding-alt:0in 5.4pt 0in 5.4pt;
|
||
mso-para-margin:0in;
|
||
mso-para-margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
font-size:10.0pt;
|
||
font-family:"Times New Roman";}
|
||
table.MsoTableGrid
|
||
{mso-style-name:"Table Grid";
|
||
mso-tstyle-rowband-size:0;
|
||
mso-tstyle-colband-size:0;
|
||
border:solid windowtext 1.0pt;
|
||
mso-border-alt:solid windowtext .5pt;
|
||
mso-padding-alt:0in 5.4pt 0in 5.4pt;
|
||
mso-border-insideh:.5pt solid windowtext;
|
||
mso-border-insidev:.5pt solid windowtext;
|
||
mso-para-margin:0in;
|
||
mso-para-margin-bottom:.0001pt;
|
||
mso-pagination:widow-orphan;
|
||
font-size:10.0pt;
|
||
font-family:"Times New Roman";}
|
||
</style>
|
||
<![endif]--><![if mso 9]>
|
||
<style>
|
||
p.MsoNormal
|
||
{margin-left:15.0pt;}
|
||
</style>
|
||
<![endif]><!--[if gte mso 9]><xml>
|
||
<o:shapedefaults v:ext="edit" spidmax="4098">
|
||
<o:colormru v:ext="edit" colors="#060"/>
|
||
<o:colormenu v:ext="edit" strokecolor="#060"/>
|
||
</o:shapedefaults></xml><![endif]--><!--[if gte mso 9]><xml>
|
||
<o:shapelayout v:ext="edit">
|
||
<o:idmap v:ext="edit" data="1"/>
|
||
</o:shapelayout></xml><![endif]-->
|
||
</head>
|
||
|
||
<body bgcolor=white lang=EN-US link="#252E78" vlink="#3D2185" style='tab-interval:
|
||
.5in;margin-left:15.0pt;margin-right:15.0pt'>
|
||
|
||
<div class=Section1>
|
||
|
||
<p class=MsoNormal style='margin-top:0in;margin-right:15.0pt;margin-bottom:
|
||
0in;margin-left:15.0pt;margin-bottom:.0001pt'><!--[if gte vml 1]><v:shapetype
|
||
id="_x0000_t75" coordsize="21600,21600" o:spt="75" o:preferrelative="t"
|
||
path="m@4@5l@4@11@9@11@9@5xe" filled="f" stroked="f">
|
||
<v:stroke joinstyle="miter"/>
|
||
<v:formulas>
|
||
<v:f eqn="if lineDrawn pixelLineWidth 0"/>
|
||
<v:f eqn="sum @0 1 0"/>
|
||
<v:f eqn="sum 0 0 @1"/>
|
||
<v:f eqn="prod @2 1 2"/>
|
||
<v:f eqn="prod @3 21600 pixelWidth"/>
|
||
<v:f eqn="prod @3 21600 pixelHeight"/>
|
||
<v:f eqn="sum @0 0 1"/>
|
||
<v:f eqn="prod @6 1 2"/>
|
||
<v:f eqn="prod @7 21600 pixelWidth"/>
|
||
<v:f eqn="sum @8 21600 0"/>
|
||
<v:f eqn="prod @7 21600 pixelHeight"/>
|
||
<v:f eqn="sum @10 21600 0"/>
|
||
</v:formulas>
|
||
<v:path o:extrusionok="f" gradientshapeok="t" o:connecttype="rect"/>
|
||
<o:lock v:ext="edit" aspectratio="t"/>
|
||
</v:shapetype><v:shape id="_x0000_s1026" type="#_x0000_t75" style='position:absolute;
|
||
left:0;text-align:left;margin-left:30pt;margin-top:9pt;width:72.75pt;height:57.75pt;
|
||
z-index:1'>
|
||
<v:imagedata src="header_files/image001.jpg" o:title="NCSAlogo"/>
|
||
</v:shape><![endif]--><![if !vml]><span style='mso-ignore:vglayout;position:
|
||
absolute;z-index:1;left:0px;margin-left:40px;margin-top:12px;width:97px;
|
||
height:77px'><img width=97 height=77 src="header_files/image002.jpg" v:shapes="_x0000_s1026"></span><![endif]><span
|
||
style='mso-spacerun:yes'> </span><b style='mso-bidi-font-weight:normal'><span
|
||
style='font-size:22.0pt'><o:p></o:p></span></b></p>
|
||
|
||
<div align=center>
|
||
|
||
<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
|
||
style='margin-left:103.45pt;border-collapse:collapse;border:none;mso-border-bottom-alt:
|
||
solid #006600 2.25pt;mso-yfti-tbllook:480;mso-padding-alt:0in 5.4pt 0in 5.4pt'>
|
||
<tr style='mso-yfti-irow:0;mso-yfti-lastrow:yes;height:29.25pt'>
|
||
<td width=443 valign=top style='width:332.6pt;border:none;border-bottom:solid #006600 2.25pt;
|
||
padding:0in 5.4pt 0in 5.4pt;height:29.25pt'>
|
||
<p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span
|
||
style='font-size:22.0pt'>HDF5 C++ API Reference Manual</span></b></p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
</div>
|
||
|
||
<p class=MsoNormal><o:p> </o:p></p>
|
||
|
||
<p class=MsoNormal><o:p> </o:p></p>
|
||
|
||
<p class=MsoNormal><o:p> </o:p></p>
|
||
|
||
</div>
|
||
|
||
</body>
|
||
|
||
</html>
|
||
<!-- Generated by Doxygen 1.3.7-20040718 -->
|
||
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
||
<h1>H5::H5Library Class Reference</h1><code>#include <<a class="el" href="H5Library_8h-source.html">H5Library.h</a>></code>
|
||
<p>
|
||
<a href="classH5_1_1H5Library-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||
<tr><td></td></tr>
|
||
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e0">open</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the HDF5 library. <a href="#e0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e1">close</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes all data to disk, closes files, and cleans up memory. <a href="#e1"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e2">dontAtExit</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instructs library not to install <code>atexit</code> cleanup routine. <a href="#e2"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e3">getLibVersion</a> (unsigned &majnum, unsigned &minnum, unsigned &relnum)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the HDF library release number. <a href="#e3"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e4">checkVersion</a> (unsigned majnum, unsigned minnum, unsigned relnum)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies that the arguments match the version numbers compiled into the library. <a href="#e4"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e5">garbageCollect</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Walks through all the garbage collection routines for the library, which are supposed to free any unused memory they have allocated. <a href="#e5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Library.html#e6">setFreeListLimits</a> (int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets limits on the different kinds of free lists. <a href="#e6"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Member Function Documentation</h2>
|
||
<a class="anchor" name="e0" doxytag="H5::H5Library::open" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::open </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Initializes the HDF5 library.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e1" doxytag="H5::H5Library::close" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::close </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Flushes all data to disk, closes files, and cleans up memory.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e2" doxytag="H5::H5Library::dontAtExit" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::dontAtExit </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Instructs library not to install <code>atexit</code> cleanup routine.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e3" doxytag="H5::H5Library::getLibVersion" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::getLibVersion </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">unsigned & </td>
|
||
<td class="mdname" nowrap> <em>majnum</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned & </td>
|
||
<td class="mdname" nowrap> <em>minnum</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned & </td>
|
||
<td class="mdname" nowrap> <em>relnum</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the HDF library release number.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>majnum</em> </td><td>- OUT: Major version of the library </td></tr>
|
||
<tr><td></td><td valign=top><em>minnum</em> </td><td>- OUT: Minor version of the library </td></tr>
|
||
<tr><td></td><td valign=top><em>relnum</em> </td><td>- OUT: Release number of the library </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e4" doxytag="H5::H5Library::checkVersion" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::checkVersion </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">unsigned </td>
|
||
<td class="mdname" nowrap> <em>majnum</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned </td>
|
||
<td class="mdname" nowrap> <em>minnum</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned </td>
|
||
<td class="mdname" nowrap> <em>relnum</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Verifies that the arguments match the version numbers compiled into the library.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>majnum</em> </td><td>- IN: Major version of the library </td></tr>
|
||
<tr><td></td><td valign=top><em>minnum</em> </td><td>- IN: Minor version of the library </td></tr>
|
||
<tr><td></td><td valign=top><em>relnum</em> </td><td>- IN: Release number of the library </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For information about library version, please refer to the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5.html#Library-VersCheck">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5.html#Library-VersCheck</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e5" doxytag="H5::H5Library::garbageCollect" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::garbageCollect </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Walks through all the garbage collection routines for the library, which are supposed to free any unused memory they have allocated.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>It is not required that <a class="el" href="classH5_1_1H5Library.html#e5">H5Library::garbageCollect</a> be called at any particular time; it is only necessary in certain situations, such as when the application has performed actions that cause the library to allocate many objects. The application should call <a class="el" href="classH5_1_1H5Library.html#e5">H5Library::garbageCollect</a> if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required. </dd></dl>
|
||
<dl compact><dt><b></b></dt><dd>The library automatically garbage collects all the free lists when the application ends. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e6" doxytag="H5::H5Library::setFreeListLimits" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> void H5::H5Library::setFreeListLimits </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">int </td>
|
||
<td class="mdname" nowrap> <em>reg_global_lim</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>reg_list_lim</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>arr_global_lim</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>arr_list_lim</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>blk_global_lim</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>blk_list_lim</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets limits on the different kinds of free lists.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>reg_global_lim</em> </td><td>- IN: Limit on all "regular" free list memory used </td></tr>
|
||
<tr><td></td><td valign=top><em>reg_list_lim</em> </td><td>- IN: Limit on memory used in each "regular" free list </td></tr>
|
||
<tr><td></td><td valign=top><em>arr_global_lim</em> </td><td>- IN: Limit on all "array" free list memory used </td></tr>
|
||
<tr><td></td><td valign=top><em>arr_list_lim</em> </td><td>- IN: Limit on memory used in each "array" free list </td></tr>
|
||
<tr><td></td><td valign=top><em>blk_global_lim</em> </td><td>- IN: Limit on all "block" free list memory used </td></tr>
|
||
<tr><td></td><td valign=top><em>blk_list_lim</em> </td><td>- IN: Limit on memory used in each "block" free list </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::LibraryIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Setting a value of -1 for a limit means no limit of that type. For more information on free list limits, please refer to C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5.html#Library-SetFreeListLimits">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5.html#Library-SetFreeListLimits</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr size="1"><address style="align: right;"><small>Generated on Thu Aug 5 00:22:44 2004 by
|
||
<a href="http://www.doxygen.org/index.html">
|
||
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7-20040718 </small></address>
|
||
</body>
|
||
</html>
|