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
1337 lines
51 KiB
HTML
1337 lines
51 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::DSetMemXferPropList Class Reference</h1><code>#include <<a class="el" href="H5DxferProp_8h-source.html">H5DxferProp.h</a>></code>
|
||
<p>
|
||
<p>Inheritance diagram for H5::DSetMemXferPropList:
|
||
<p><center><img src="classH5_1_1DSetMemXferPropList.png" usemap="#H5::DSetMemXferPropList_map" border="0" alt=""></center>
|
||
<map name="H5::DSetMemXferPropList_map">
|
||
<area href="classH5_1_1PropList.html" alt="H5::PropList" shape="rect" coords="0,56,159,80">
|
||
<area href="classH5_1_1IdComponent.html" alt="H5::IdComponent" shape="rect" coords="0,0,159,24">
|
||
</map>
|
||
<a href="classH5_1_1DSetMemXferPropList-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_1DSetMemXferPropList.html#a0">setBuffer</a> (size_t size, void *tconv, void *bkg) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets type conversion and background buffers. <a href="#a0"></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_1DSetMemXferPropList.html#a1">getBuffer</a> (void **tconv, void **bkg) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads buffer settings. <a href="#a1"></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_1DSetMemXferPropList.html#a2">setBtreeRatios</a> (double left, double middle, double right) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets B-tree split ratios for a dataset transfer property list. <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_1DSetMemXferPropList.html#a3">getBtreeRatios</a> (double &left, double &middle, double &right) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets B-tree split ratios for a dataset transfer property list. <a href="#a3"></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_1DSetMemXferPropList.html#a4">setPreserve</a> (bool status) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the dataset transfer property list status to true or false. <a href="#a4"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1DSetMemXferPropList.html#a5">getPreserve</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks status of the dataset transfer property list. <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_1DSetMemXferPropList.html#a6">setVlenMemManager</a> (H5MM_allocate_t alloc, void *alloc_info, H5MM_free_t free, void *free_info) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the memory manager for variable-length datatype allocation. <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_1DSetMemXferPropList.html#a7">setVlenMemManager</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the memory manager for variable-length datatype allocation - system <code>malloc</code> and <code>free</code> will be used. <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_1DSetMemXferPropList.html#a8">getVlenMemManager</a> (H5MM_allocate_t &alloc, void **alloc_info, H5MM_free_t &free, void **free_info) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the memory manager for variable-length datatype allocation. <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_1DSetMemXferPropList.html#a9">setMulti</a> (const hid_t *memb_dxpl)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the data transfer property list for the multi-file driver. <a href="#a9"></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_1DSetMemXferPropList.html#a10">getMulti</a> (hid_t *memb_dxpl)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns multi-file data transfer property list information. <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_1DSetMemXferPropList.html#a11">setSmallDataBlockSize</a> (hsize_t size)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of a contiguous block reserved for small data. <a href="#a11"></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_1DSetMemXferPropList.html#a12">getSmallDataBlockSize</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current small data block size setting. <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_1DSetMemXferPropList.html#a13">setHyperVectorSize</a> (size_t vector_size)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets number of I/O vectors to be read/written in hyperslab I/O. <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_1DSetMemXferPropList.html#a14">getHyperVectorSize</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of I/O vectors to be read/written in hyperslab I/O. <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_1DSetMemXferPropList.html#a15">setEDCCheck</a> (H5Z_EDC_t check)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables error-detecting for a dataset reading process. <a href="#a15"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>H5Z_EDC_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1DSetMemXferPropList.html#a16">getEDCCheck</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether error-detection is enabled for dataset reads. <a href="#a16"></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_1DSetMemXferPropList.html#a17">DSetMemXferPropList</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor: creates a stub dataset memory and transfer property list object. <a href="#a17"></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_1DSetMemXferPropList.html#a18">DSetMemXferPropList</a> (const <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a> &orig)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a> object. <a href="#a18"></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_1DSetMemXferPropList.html#a19">DSetMemXferPropList</a> (const hid_t plist_id)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a> object using the id of an existing <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>. <a href="#a19"></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_1DSetMemXferPropList.html#a20">~DSetMemXferPropList</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a20"></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_1DSetMemXferPropList.html">DSetMemXferPropList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1DSetMemXferPropList.html#s0">DEFAULT</a></td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constant for default dataset memory and transfer property list. <a href="#s0"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="a17" doxytag="H5::DSetMemXferPropList::DSetMemXferPropList" ></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::DSetMemXferPropList::DSetMemXferPropList </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 stub dataset memory and transfer property list object.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a18" doxytag="H5::DSetMemXferPropList::DSetMemXferPropList" ></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::DSetMemXferPropList::DSetMemXferPropList </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a> & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>original</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_1DSetMemXferPropList.html">DSetMemXferPropList</a> object.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>original</em> </td><td>- IN: Original dataset memory and transfer property list object to copy </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a19" doxytag="H5::DSetMemXferPropList::DSetMemXferPropList" ></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::DSetMemXferPropList::DSetMemXferPropList </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 <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a> object using the id of an existing <a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>plist_id</em> </td><td>- IN: Id of an existing dataset memory and transfer property list </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a20" doxytag="H5::DSetMemXferPropList::~DSetMemXferPropList" ></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::DSetMemXferPropList::~<a class="el" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</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::DSetMemXferPropList::setBuffer" ></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::DSetMemXferPropList::setBuffer </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">size_t </td>
|
||
<td class="mdname" nowrap> <em>size</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>tconv</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>bkg</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 type conversion and background buffers.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>size</em> </td><td>- IN: Size, in bytes, of the type conversion and background buffers </td></tr>
|
||
<tr><td></td><td valign=top><em>tconv</em> </td><td>- IN: Pointer to application-allocated type conversion buffer </td></tr>
|
||
<tr><td></td><td valign=top><em>bkg</em> </td><td>- IN: Pointer to application-allocated background 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>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="H5::DSetMemXferPropList::getBuffer" ></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::DSetMemXferPropList::getBuffer </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">void ** </td>
|
||
<td class="mdname" nowrap> <em>tconv</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void ** </td>
|
||
<td class="mdname" nowrap> <em>bkg</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>
|
||
Reads buffer settings.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>tconv</em> </td><td>- IN: Pointer to application-allocated type conversion buffer </td></tr>
|
||
<tr><td></td><td valign=top><em>bkg</em> </td><td>- IN: Pointer to application-allocated background buffer </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>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="a2" doxytag="H5::DSetMemXferPropList::setBtreeRatios" ></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::DSetMemXferPropList::setBtreeRatios </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">double </td>
|
||
<td class="mdname" nowrap> <em>left</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double </td>
|
||
<td class="mdname" nowrap> <em>middle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double </td>
|
||
<td class="mdname" nowrap> <em>right</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 B-tree split ratios for a dataset transfer 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>left</em> </td><td>- IN: B-tree split ratio for left-most nodes </td></tr>
|
||
<tr><td></td><td valign=top><em>middle</em> </td><td>- IN: B-tree split ratio for right-most nodes and lone nodes </td></tr>
|
||
<tr><td></td><td valign=top><em>right</em> </td><td>- IN: B-tree split ratio for all other nodes </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="a3" doxytag="H5::DSetMemXferPropList::getBtreeRatios" ></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::DSetMemXferPropList::getBtreeRatios </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">double & </td>
|
||
<td class="mdname" nowrap> <em>left</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double & </td>
|
||
<td class="mdname" nowrap> <em>middle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>double & </td>
|
||
<td class="mdname" nowrap> <em>right</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>
|
||
Gets B-tree split ratios for a dataset transfer 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>left</em> </td><td>- OUT: B-tree split ratio for left-most nodes </td></tr>
|
||
<tr><td></td><td valign=top><em>middle</em> </td><td>- OUT: B-tree split ratio for right-most nodes and lone nodes </td></tr>
|
||
<tr><td></td><td valign=top><em>right</em> </td><td>- OUT: B-tree split ratio for all other nodes </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::DSetMemXferPropList::setPreserve" ></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::DSetMemXferPropList::setPreserve </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">bool </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>status</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 dataset transfer property list status to true or false.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>status</em> </td><td>- IN: Status to set, true or false </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="a5" doxytag="H5::DSetMemXferPropList::getPreserve" ></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"> bool H5::DSetMemXferPropList::getPreserve </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>
|
||
Checks status of the dataset transfer property list.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the dataset transfer property list </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="a6" doxytag="H5::DSetMemXferPropList::setVlenMemManager" ></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::DSetMemXferPropList::setVlenMemManager </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5MM_allocate_t </td>
|
||
<td class="mdname" nowrap> <em>alloc_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>alloc_info</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5MM_free_t </td>
|
||
<td class="mdname" nowrap> <em>free_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>free_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>
|
||
Sets the memory manager for variable-length datatype allocation.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>alloc_func</em> </td><td>- IN: User's allocate routine </td></tr>
|
||
<tr><td></td><td valign=top><em>alloc_info</em> </td><td>- IN: User's allocation parameters </td></tr>
|
||
<tr><td></td><td valign=top><em>free_func</em> </td><td>- IN: User's free routine </td></tr>
|
||
<tr><td></td><td valign=top><em>free_info</em> </td><td>- IN: User's free parameters </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="a7" doxytag="H5::DSetMemXferPropList::setVlenMemManager" ></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::DSetMemXferPropList::setVlenMemManager </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>
|
||
Sets the memory manager for variable-length datatype allocation - system <code>malloc</code> and <code>free</code> will be used.
|
||
<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="a8" doxytag="H5::DSetMemXferPropList::getVlenMemManager" ></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::DSetMemXferPropList::getVlenMemManager </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5MM_allocate_t & </td>
|
||
<td class="mdname" nowrap> <em>alloc_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void ** </td>
|
||
<td class="mdname" nowrap> <em>alloc_info</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5MM_free_t & </td>
|
||
<td class="mdname" nowrap> <em>free_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void ** </td>
|
||
<td class="mdname" nowrap> <em>free_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>
|
||
Gets the memory manager for variable-length datatype allocation.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>alloc_func</em> </td><td>- OUT: User's allocate routine </td></tr>
|
||
<tr><td></td><td valign=top><em>alloc_info</em> </td><td>- OUT: User's allocation parameters </td></tr>
|
||
<tr><td></td><td valign=top><em>free_func</em> </td><td>- OUT: User's free routine </td></tr>
|
||
<tr><td></td><td valign=top><em>free_info</em> </td><td>- OUT: User's free parameters </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="a9" doxytag="H5::DSetMemXferPropList::setMulti" ></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::DSetMemXferPropList::setMulti </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const hid_t * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>memb_dxpl</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 data transfer property list for the multi-file 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_dxpl</em> </td><td>- OUT: Array of data access property lists </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>This function can only be used after the member map has been set with FileAccPropList::setMulti (not done - BMR.) </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="H5::DSetMemXferPropList::getMulti" ></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::DSetMemXferPropList::getMulti </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hid_t * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>memb_dxpl</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>
|
||
Returns multi-file data transfer property list information.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>memb_dxpl</em> </td><td>- OUT: Array of data access property lists </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="a11" doxytag="H5::DSetMemXferPropList::setSmallDataBlockSize" ></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::DSetMemXferPropList::setSmallDataBlockSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>size</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 size of a contiguous block reserved for small data.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>size</em> </td><td>- IN: Maximum size, in bytes, of the small data block. </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, please refer to the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetSmallData">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetSmallData</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a12" doxytag="H5::DSetMemXferPropList::getSmallDataBlockSize" ></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::DSetMemXferPropList::getSmallDataBlockSize </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 current small data block size setting.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Size of the small data block, 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="a13" doxytag="H5::DSetMemXferPropList::setHyperVectorSize" ></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::DSetMemXferPropList::setHyperVectorSize </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">size_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>vector_size</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 number of I/O vectors to be read/written in hyperslab I/O.
|
||
<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>
|
||
<dl compact><dt><b>Description</b></dt><dd>For information, please refer to the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetHyperVectorSize">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetHyperVectorSize</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a14" doxytag="H5::DSetMemXferPropList::getHyperVectorSize" ></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::DSetMemXferPropList::getHyperVectorSize </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 number of I/O vectors to be read/written in hyperslab I/O.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Number of I/O vectors </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::DSetMemXferPropList::setEDCCheck" ></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::DSetMemXferPropList::setEDCCheck </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5Z_EDC_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>check</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>
|
||
Enables or disables error-detecting for a dataset reading process.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>check</em> </td><td>- IN: Specifies whether error detection is enabled or disabled </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 error detection algorithm used is the algorithm previously specified in the corresponding dataset creation property list. This function does not affect the use of error detection in the writing process. </dd></dl>
|
||
<dl compact><dt><b></b></dt><dd>Valid values are as follows: <ul>
|
||
<li><code>H5Z_ENABLE_EDC</code> (default) </li>
|
||
<li><code>H5Z_DISABLE_EDC</code> </li>
|
||
</ul>
|
||
</dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a16" doxytag="H5::DSetMemXferPropList::getEDCCheck" ></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"> H5Z_EDC_t H5::DSetMemXferPropList::getEDCCheck </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>
|
||
Determines whether error-detection is enabled for dataset reads.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><code>H5Z_ENABLE_EDC</code> or <code>H5Z_DISABLE_EDC</code> </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::DSetMemXferPropList::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_1DSetMemXferPropList.html">DSetMemXferPropList</a> <a class="el" href="classH5_1_1DSetMemXferPropList.html#s0">H5::DSetMemXferPropList::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 dataset memory and transfer property list.
|
||
<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>
|