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
1916 lines
77 KiB
HTML
1916 lines
77 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::FileAccPropList Class Reference</h1><code>#include <<a class="el" href="H5FaccProp_8h-source.html">H5FaccProp.h</a>></code>
|
||
<p>
|
||
<p>Inheritance diagram for H5::FileAccPropList:
|
||
<p><center><img src="classH5_1_1FileAccPropList.png" usemap="#H5::FileAccPropList_map" border="0" alt=""></center>
|
||
<map name="H5::FileAccPropList_map">
|
||
<area href="classH5_1_1PropList.html" alt="H5::PropList" shape="rect" coords="0,56,124,80">
|
||
<area href="classH5_1_1IdComponent.html" alt="H5::IdComponent" shape="rect" coords="0,0,124,24">
|
||
</map>
|
||
<a href="classH5_1_1FileAccPropList-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||
<tr><td></td></tr>
|
||
<tr><td colspan=2><br><h2>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_1FileAccPropList.html#a0">setStdio</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifies this property list to use the <code>H5FD_STDIO</code> driver. <a href="#a0"></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_1FileAccPropList.html#a1">setDriver</a> (hid_t new_driver_id, const void *new_driver_info) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set file driver for this property list. <a href="#a1"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>hid_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a2">getDriver</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ID of the low-level file driver. <a href="#a2"></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_1FileAccPropList.html#a3">setFamilyOffset</a> (hsize_t offset) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets offset for family driver. <a href="#a3"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>hsize_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a4">getFamilyOffset</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get offset for family driver. <a href="#a4"></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_1FileAccPropList.html#a5">setSec2</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifies this file access property list to use the sec2 driver. <a href="#a5"></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_1FileAccPropList.html#a6">setCore</a> (size_t increment, hbool_t backing_store) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifies this file access property list to use the <code>H5FD_CORE</code> driver. <a href="#a6"></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_1FileAccPropList.html#a7">getCore</a> (size_t &increment, hbool_t &backing_store) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries core file driver properties. <a href="#a7"></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_1FileAccPropList.html#a8">setFamily</a> (hsize_t memb_size, const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &memb_plist) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets this file access property list to use the family driver. <a href="#a8"></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_1FileAccPropList.html#a9">getFamily</a> (hsize_t &memb_size, <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &memb_plist) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns information about the family file access property list. <a href="#a9"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a10">getFamily</a> (hsize_t &memb_size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts and its return value. <a href="#a10"></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_1FileAccPropList.html#a11">setSplit</a> (<a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &meta_plist, <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &raw_plist, const char *meta_ext=".meta", const char *raw_ext=".raw") const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emulates the old split file driver, which stored meta data in one file and raw data in another file. <a href="#a11"></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_1FileAccPropList.html#a12">setSplit</a> (<a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &meta_plist, <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &raw_plist, const string &meta_ext, const string &raw_ext) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. <a href="#a12"></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_1FileAccPropList.html#a13">setSieveBufSize</a> (size_t bufsize) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum size of the data sieve buffer. <a href="#a13"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a14">getSieveBufSize</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current settings for the data sieve buffer size property from this property list. <a href="#a14"></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_1FileAccPropList.html#a15">setMetaBlockSize</a> (hsize_t &block_size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum size of metadata block allocations. <a href="#a15"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>hsize_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a16">getMetaBlockSize</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current metadata block size setting. <a href="#a16"></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_1FileAccPropList.html#a17">setLog</a> (const char *logfile, unsigned flags, size_t buf_size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifies this file access property list to use the logging driver. <a href="#a17"></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_1FileAccPropList.html#a18">setLog</a> (const string &logfile, unsigned flags, size_t buf_size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. <a href="#a18"></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_1FileAccPropList.html#a19">setAlignment</a> (hsize_t threshold=1, hsize_t alignment=1) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the alignment properties of this property list. <a href="#a19"></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_1FileAccPropList.html#a20">getAlignment</a> (hsize_t &threshold, hsize_t &alignment) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current settings for alignment properties from this property list. <a href="#a20"></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_1FileAccPropList.html#a21">setMultiType</a> (H5FD_mem_t dtype) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets data type for <code>MULTI</code> driver. <a href="#a21"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>H5FD_mem_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a22">getMultiType</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the data type property for <code>MULTI</code> driver. <a href="#a22"></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_1FileAccPropList.html#a23">setCache</a> (int mdc_nelmts, size_t rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the meta data cache and raw data chunk cache parameters. Sets the meta data cache and raw data chunk cache parameters. <a href="#a23"></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_1FileAccPropList.html#a24">getCache</a> (int &mdc_nelmts, size_t &rdcc_nelmts, size_t &rdcc_nbytes, double &rdcc_w0) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries the meta data cache and raw data chunk cache parameters. <a href="#a24"></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_1FileAccPropList.html#a25">setFcloseDegree</a> (H5F_close_degree_t degree)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the degree for the file close behavior. <a href="#a25"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>H5F_close_degree_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a26">getFcloseDegree</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the degree for the file close behavior. <a href="#a26"></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_1FileAccPropList.html#a27">setGcReferences</a> (unsigned gc_ref=0) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets garbage collecting references flag. <a href="#a27"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a28">getGcReferences</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the garbage collecting references setting. <a href="#a28"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a29">FileAccPropList</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor: creates a file access property list. <a href="#a29"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a30">FileAccPropList</a> (const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &original)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a>. <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> object. <a href="#a30"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a31">FileAccPropList</a> (const hid_t plist_id)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a file access property list using the id of an existing one. <a href="#a31"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#a32">~FileAccPropList</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a32"></a><br></td></tr>
|
||
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1FileAccPropList.html#s0">DEFAULT</a></td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constant for default property. <a href="#s0"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="a29" doxytag="H5::FileAccPropList::FileAccPropList" ></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"> H5::FileAccPropList::FileAccPropList </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Default constructor: creates a file access property list.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a30" doxytag="H5::FileAccPropList::FileAccPropList" ></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"> H5::FileAccPropList::FileAccPropList </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>orig</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a>. <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> object.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a31" doxytag="H5::FileAccPropList::FileAccPropList" ></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"> H5::FileAccPropList::FileAccPropList </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const hid_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>plist_id</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Creates a file access property list using the id of an existing one.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a32" doxytag="H5::FileAccPropList::~FileAccPropList" ></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"> H5::FileAccPropList::~<a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> </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> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Noop destructor.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr><h2>Member Function Documentation</h2>
|
||
<a class="anchor" name="a0" doxytag="H5::FileAccPropList::setStdio" ></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::FileAccPropList::setStdio </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Modifies this property list to use the <code>H5FD_STDIO</code> driver.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="H5::FileAccPropList::setDriver" ></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::FileAccPropList::setDriver </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hid_t </td>
|
||
<td class="mdname" nowrap> <em>new_driver_id</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const void * </td>
|
||
<td class="mdname" nowrap> <em>new_driver_info</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Set file driver for this property list.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>new_driver_id</em> </td><td>- IN: File driver </td></tr>
|
||
<tr><td></td><td valign=top><em>new_driver_info</em> </td><td>- IN: Struct containing the driver-specific properites </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For a list of valid driver identifiers, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetDriver">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetDriver</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a2" doxytag="H5::FileAccPropList::getDriver" ></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"> hid_t H5::FileAccPropList::getDriver </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Return the ID of the low-level file driver.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>A low-level driver ID which is the same ID used when the driver was set for the property list. The driver ID is only valid as long as the file driver remains registered. Valid driver identifiers can be found at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetDriver">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetDriver</a> </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a3" doxytag="H5::FileAccPropList::setFamilyOffset" ></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::FileAccPropList::setFamilyOffset </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>offset</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets offset for family driver.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>offset</em> </td><td>- IN: offset value </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a4" doxytag="H5::FileAccPropList::getFamilyOffset" ></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"> hsize_t H5::FileAccPropList::getFamilyOffset </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Get offset for family driver.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Offset for family driver </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a5" doxytag="H5::FileAccPropList::setSec2" ></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::FileAccPropList::setSec2 </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Modifies this file access property list to use the sec2 driver.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a6" doxytag="H5::FileAccPropList::setCore" ></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::FileAccPropList::setCore </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">size_t </td>
|
||
<td class="mdname" nowrap> <em>increment</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>hbool_t </td>
|
||
<td class="mdname" nowrap> <em>backing_store</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Modifies this file access property list to use the <code>H5FD_CORE</code> driver.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>increment</em> </td><td>- IN: Specifies how much memory to increase each time more memory is needed, in bytes </td></tr>
|
||
<tr><td></td><td valign=top><em>backing_store</em> </td><td>- IN: Indicating whether to write the file contents to disk when the file is closed </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For more details on the use of <code>H5FD_CORE</code> driver, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplCore">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplCore</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a7" doxytag="H5::FileAccPropList::getCore" ></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::FileAccPropList::getCore </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">size_t & </td>
|
||
<td class="mdname" nowrap> <em>increment</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>hbool_t & </td>
|
||
<td class="mdname" nowrap> <em>backing_store</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Queries core file driver properties.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>increment</em> </td><td>- OUT: Size of memory increment, in bytes </td></tr>
|
||
<tr><td></td><td valign=top><em>backing_store</em> </td><td>- OUT: Indicating whether to write the file contents to disk when the file is closed </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a8" doxytag="H5::FileAccPropList::setFamily" ></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::FileAccPropList::setFamily </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname" nowrap> <em>memb_size</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>memb_plist</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets this file access property list to use the family driver.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>memb_size</em> </td><td>- IN: Size in bytes of each file member </td></tr>
|
||
<tr><td></td><td valign=top><em>memb_plist</em> </td><td>- IN: File access property list to be used for each family member </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Note that <em>memb_size</em> is used only when creating a new file. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a9" doxytag="H5::FileAccPropList::getFamily" ></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::FileAccPropList::getFamily </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t & </td>
|
||
<td class="mdname" nowrap> <em>memb_size</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>memb_plist</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns information about the family file access property list.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>memb_size</em> </td><td>- OUT: Size in bytes of each file member </td></tr>
|
||
<tr><td></td><td valign=top><em>memb_plist</em> </td><td>- OUT: Retrieved file access property list for each file member </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="H5::FileAccPropList::getFamily" ></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"> <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> H5::FileAccPropList::getFamily </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>memb_size</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts and its return value.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>memb_size</em> </td><td>- OUT: Size in bytes of each file member </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>The file access property list for each file member </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a11" doxytag="H5::FileAccPropList::setSplit" ></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::FileAccPropList::setSplit </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top"><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>meta_plist</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>raw_plist</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const char * </td>
|
||
<td class="mdname" nowrap> <em>meta_ext</em> = <code>".meta"</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const char * </td>
|
||
<td class="mdname" nowrap> <em>raw_ext</em> = <code>".raw"</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Emulates the old split file driver, which stored meta data in one file and raw data in another file.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>meta_plist</em> </td><td>- IN: File access plist for the metadata file </td></tr>
|
||
<tr><td></td><td valign=top><em>raw_plist</em> </td><td>- IN: File access plist for the raw data file </td></tr>
|
||
<tr><td></td><td valign=top><em>meta_ext</em> </td><td>- IN: Metadata filename extension as <code>char*</code> </td></tr>
|
||
<tr><td></td><td valign=top><em>raw_ext</em> </td><td>- IN: Raw data filename extension as <code>char*</code> </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Temporary - For information, please refer to: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplSplit">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplSplit</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a12" doxytag="H5::FileAccPropList::setSplit" ></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::FileAccPropList::setSplit </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top"><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>meta_plist</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>raw_plist</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const string & </td>
|
||
<td class="mdname" nowrap> <em>meta_ext</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const string & </td>
|
||
<td class="mdname" nowrap> <em>raw_ext</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>meta_plist</em> </td><td>- IN: File access plist for the metadata file </td></tr>
|
||
<tr><td></td><td valign=top><em>raw_plist</em> </td><td>- IN: File access plist for the raw data file </td></tr>
|
||
<tr><td></td><td valign=top><em>meta_ext</em> </td><td>- IN: Metadata filename extension as <code>string</code> </td></tr>
|
||
<tr><td></td><td valign=top><em>raw_ext</em> </td><td>- IN: Raw data filename extension as <code>string</code> </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a13" doxytag="H5::FileAccPropList::setSieveBufSize" ></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::FileAccPropList::setSieveBufSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">size_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>bufsize</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the maximum size of the data sieve buffer.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>bufsize</em> </td><td>- IN: Maximum size, in bytes, of data sieve buffer </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For detail on data sieving, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetSieveBufSize">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetSieveBufSize</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a14" doxytag="H5::FileAccPropList::getSieveBufSize" ></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"> size_t H5::FileAccPropList::getSieveBufSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the current settings for the data sieve buffer size property from this property list.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Data sieve buffer size, in bytes </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a15" doxytag="H5::FileAccPropList::setMetaBlockSize" ></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::FileAccPropList::setMetaBlockSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>block_size</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the minimum size of metadata block allocations.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>block_size</em> </td><td>- IN: Minimum size, in bytes, of metadata block allocations </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For more detail, please see the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetMetaBlockSize">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetMetaBlockSize</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a16" doxytag="H5::FileAccPropList::getMetaBlockSize" ></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"> hsize_t H5::FileAccPropList::getMetaBlockSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the current metadata block size setting.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Metadata block size </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a17" doxytag="H5::FileAccPropList::setLog" ></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::FileAccPropList::setLog </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname" nowrap> <em>logfile</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned </td>
|
||
<td class="mdname" nowrap> <em>flags</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t </td>
|
||
<td class="mdname" nowrap> <em>buf_size</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Modifies this file access property list to use the logging driver.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>logfile</em> </td><td>- IN: Name of the log file </td></tr>
|
||
<tr><td></td><td valign=top><em>flags</em> </td><td>- IN: Flags specifying the types of logging activity </td></tr>
|
||
<tr><td></td><td valign=top><em>buf_size</em> </td><td>- IN: Size of the logging buffer </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For detail on <em>flags</em>, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplStream">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplStream</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a18" doxytag="H5::FileAccPropList::setLog" ></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::FileAccPropList::setLog </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const string & </td>
|
||
<td class="mdname" nowrap> <em>logfile</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned </td>
|
||
<td class="mdname" nowrap> <em>flags</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t </td>
|
||
<td class="mdname" nowrap> <em>buf_size</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>logfile</em> </td><td>- IN: Name of the log file - string </td></tr>
|
||
<tr><td></td><td valign=top><em>flags</em> </td><td>- IN: Flags specifying the types of logging activity </td></tr>
|
||
<tr><td></td><td valign=top><em>buf_size</em> </td><td>- IN: Size of the logging buffer </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a19" doxytag="H5::FileAccPropList::setAlignment" ></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::FileAccPropList::setAlignment </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname" nowrap> <em>threshold</em> = <code>1</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>hsize_t </td>
|
||
<td class="mdname" nowrap> <em>alignment</em> = <code>1</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the alignment properties of this property list.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>threshold</em> </td><td>- IN: Threshold value for file object size </td></tr>
|
||
<tr><td></td><td valign=top><em>alignment</em> </td><td>- IN: Alignment value </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The parameter <em>threshold</em> must have a non-negative value. Note that setting the threshold value to 0 (zero) has the effect of a special case, forcing everything to be aligned. The parameter <em>alignment</em> must have a positive value.</dd></dl>
|
||
For detail on <em>setting</em> alignment, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetAlignment">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetAlignment</a> </td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a20" doxytag="H5::FileAccPropList::getAlignment" ></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::FileAccPropList::getAlignment </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t & </td>
|
||
<td class="mdname" nowrap> <em>threshold</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>hsize_t & </td>
|
||
<td class="mdname" nowrap> <em>alignment</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the current settings for alignment properties from this property list.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>threshold</em> </td><td>- OUT: Retrieved threshold value for file object size </td></tr>
|
||
<tr><td></td><td valign=top><em>alignment</em> </td><td>- OUT: Retrieved alignment value </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a21" doxytag="H5::FileAccPropList::setMultiType" ></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::FileAccPropList::setMultiType </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5FD_mem_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>dtype</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets data type for <code>MULTI</code> driver.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>dtype</em> </td><td>- IN: Type of data </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>More details and valid values for <em>dtype</em> can be found at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetMultiType">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetMultiType</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a22" doxytag="H5::FileAccPropList::getMultiType" ></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"> H5FD_mem_t H5::FileAccPropList::getMultiType </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the data type property for <code>MULTI</code> driver.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>The data type property </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>More details and possible returned values can be found at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetMultiType">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetMultiType</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a23" doxytag="H5::FileAccPropList::setCache" ></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::FileAccPropList::setCache </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">int </td>
|
||
<td class="mdname" nowrap> <em>mdc_nelmts</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t </td>
|
||
<td class="mdname" nowrap> <em>rdcc_nelmts</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t </td>
|
||
<td class="mdname" nowrap> <em>rdcc_nbytes</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double </td>
|
||
<td class="mdname" nowrap> <em>rdcc_w0</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the meta data cache and raw data chunk cache parameters. Sets the meta data cache and raw data chunk cache parameters.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>mdc_nelmts</em> </td><td>- IN: Number of elements in the meta data cache </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_nelmts</em> </td><td>- IN: Number of elements in the raw data chunk cache </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_nbytes</em> </td><td>- IN: Total size of the raw data chunk cache, in bytes </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_w0</em> </td><td>- IN: Preemption policy </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The argument <em>rdcc_w0</em> should hold a value between 0 and 1 inclusive. This value indicates how much chunks that have been fully read are favored for preemption. A value of zero means fully read chunks are treated no differently than other chunks (the preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a24" doxytag="H5::FileAccPropList::getCache" ></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::FileAccPropList::getCache </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">int & </td>
|
||
<td class="mdname" nowrap> <em>mdc_nelmts</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t & </td>
|
||
<td class="mdname" nowrap> <em>rdcc_nelmts</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>size_t & </td>
|
||
<td class="mdname" nowrap> <em>rdcc_nbytes</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double & </td>
|
||
<td class="mdname" nowrap> <em>rdcc_w0</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Queries the meta data cache and raw data chunk cache parameters.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>mdc_nelmts</em> </td><td>- OUT: Number of elements in the meta data cache </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_nelmts</em> </td><td>- OUT: Number of elements in the raw data chunk cache </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_nbytes</em> </td><td>- OUT: Total size of the raw data chunk cache, in bytes </td></tr>
|
||
<tr><td></td><td valign=top><em>rdcc_w0</em> </td><td>- OUT: Preemption policy </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a25" doxytag="H5::FileAccPropList::setFcloseDegree" ></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::FileAccPropList::setFcloseDegree </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5F_close_degree_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>degree</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the degree for the file close behavior.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>degree</em> </td><td>- IN: </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a26" doxytag="H5::FileAccPropList::getFcloseDegree" ></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"> H5F_close_degree_t H5::FileAccPropList::getFcloseDegree </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the degree for the file close behavior.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>The degree for the file close behavior </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a27" doxytag="H5::FileAccPropList::setGcReferences" ></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::FileAccPropList::setGcReferences </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">unsigned </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>gc_ref</em> = <code>0</code> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets garbage collecting references flag.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>gc_ref</em> </td><td>- IN: Flag setting reference garbage collection to on (1) or off (0). </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::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For detail on <em>fapl</em>, please refer to <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplStream">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplStream</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a28" doxytag="H5::FileAccPropList::getGcReferences" ></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"> unsigned H5::FileAccPropList::getGcReferences </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the garbage collecting references setting.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Garbage collecting references setting, 0 (off) or 1 (on) </dd></dl>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::PropListIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr><h2>Member Data Documentation</h2>
|
||
<a class="anchor" name="s0" doxytag="H5::FileAccPropList::DEFAULT" ></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"> const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> <a class="el" href="classH5_1_1FileAccPropList.html#s0">H5::FileAccPropList::DEFAULT</a><code> [static]</code> </td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Constant for default property.
|
||
<p>
|
||
|
||
<p>
|
||
Reimplemented from <a class="el" href="classH5_1_1PropList.html#s0">H5::PropList</a>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr size="1"><address style="align: right;"><small>Generated on Thu Aug 5 00:22:43 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>
|