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
1485 lines
60 KiB
HTML
1485 lines
60 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::H5File Class Reference</h1><code>#include <<a class="el" href="H5File_8h-source.html">H5File.h</a>></code>
|
||
<p>
|
||
<p>Inheritance diagram for H5::H5File:
|
||
<p><center><img src="classH5_1_1H5File.png" usemap="#H5::H5File_map" border="0" alt=""></center>
|
||
<map name="H5::H5File_map">
|
||
<area href="classH5_1_1IdComponent.html" alt="H5::IdComponent" shape="rect" coords="0,0,107,24">
|
||
<area href="classH5_1_1CommonFG.html" alt="H5::CommonFG" shape="rect" coords="117,0,224,24">
|
||
</map>
|
||
<a href="classH5_1_1H5File-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> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a0">H5File</a> (const char *name, unsigned int flags, const <a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> &create_plist=<a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a>, const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &access_plist=<a class="el" href="classH5_1_1FileAccPropList.html#s0">FileAccPropList::DEFAULT</a>)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates or opens an HDF5 file depending on the parameter flags. <a href="#a0"></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_1H5File.html#a1">H5File</a> (const string &name, unsigned int flags, const <a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> &create_plist=<a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a>, const <a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &access_plist=<a class="el" href="classH5_1_1FileAccPropList.html#s0">FileAccPropList::DEFAULT</a>)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is another overloaded constructor. It differs from the above constructor only in the type of the <em>name</em> argument. <a href="#a1"></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_1H5File.html#a2">getAccessPlist</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the access property list of this file. <a href="#a2"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a3">getCreatePlist</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the creation property list of this file. <a href="#a3"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a4">getFileName</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of this file. <a href="#a4"></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_1H5File.html#a5">getFileSize</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file size of the HDF5 file. <a href="#a5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>hssize_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a6">getFreeSpace</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of free space in the file. <a href="#a6"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a7">getObjCount</a> (unsigned types) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of opened object IDs (files, datasets, groups and datatypes) in the same file. <a href="#a7"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a8">getObjCount</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It takes no parameter and returns the object count of all object types. <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_1H5File.html#a9">getObjIDs</a> (unsigned types, int max_objs, hid_t *oid_list) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a list of opened object IDs (files, datasets, groups and datatypes) in the same file. <a href="#a9"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>H5G_obj_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a10">getObjType</a> (void *ref, H5R_type_t ref_type) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <a href="#a10"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a11">getRegion</a> (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a dataspace with the region pointed to selected. <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_1H5File.html#a12">getVFDHandle</a> (<a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> &fapl, void **file_handle) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the file handle of the low-level file driver. <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_1H5File.html#a13">getVFDHandle</a> (void **file_handle) 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="#a13"></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_1H5File.html#a14">reOpen</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reopens this file. <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_1H5File.html#a15">reopen</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reopens this file. <a href="#a15"></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_1H5File.html#a16">Reference</a> (const char *name, <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a reference to an Hdf5 object or a dataset region. <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_1H5File.html#a17">Reference</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded function, provided for your convenience. It differs from the above function in that it only creates a reference to an HDF5 object, not to a dataset region. <a href="#a17"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a18">throwException</a> (const string func_name, const string msg) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Throws file exception - initially implemented for <a class="el" href="classH5_1_1CommonFG.html">CommonFG</a>. <a href="#a18"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual hid_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a19">getLocId</a> () const</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#a20">H5File</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor: creates a stub <a class="el" href="classH5_1_1H5File.html">H5File</a> object. <a href="#a20"></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_1H5File.html#a21">H5File</a> (const <a class="el" href="classH5_1_1H5File.html">H5File</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_1H5File.html">H5File</a> object. <a href="#a21"></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_1H5File.html#a22">~H5File</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Properly terminates access to this file. <a href="#a22"></a><br></td></tr>
|
||
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5File.html#e0">isHdf5</a> (const char *name)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a file in HDF5 format. <a href="#e0"></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_1H5File.html#e1">isHdf5</a> (const string &name)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It takes an <code>std::string</code> for <em>name</em>. <a href="#e1"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="a0" doxytag="H5::H5File::H5File" ></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::H5File::H5File </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname" nowrap> <em>name</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned int </td>
|
||
<td class="mdname" nowrap> <em>flags</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a></code>, </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>access_plist</em> = <code><a class="el" href="classH5_1_1FileAccPropList.html#s0">FileAccPropList::DEFAULT</a></code></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Creates or opens an HDF5 file depending on the parameter flags.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN: Name of the file </td></tr>
|
||
<tr><td></td><td valign=top><em>flags</em> </td><td>- IN: File access flags </td></tr>
|
||
<tr><td></td><td valign=top><em>create_plist</em> </td><td>- IN: File creation property list, used when modifying default file meta-data. Default to <a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a> </td></tr>
|
||
<tr><td></td><td valign=top><em>access_plist</em> </td><td>- IN: File access property list. Default to <a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Valid values of <em>flags</em> include: <ul>
|
||
<li><code>H5F_ACC_TRUNC</code> - Truncate file, if it already exists, erasing all data previously stored in the file. </li>
|
||
<li><code>H5F_ACC_EXCL</code> - Fail if file already exists. <code>H5F_ACC_TRUNC</code> and <code>H5F_ACC_EXCL</code> are mutually exclusive </li>
|
||
<li><code>H5F_ACC_DEBUG</code> - print debug information. This flag is used only by HDF5 library developers; it is neither tested nor supported for use in applications. </li>
|
||
</ul>
|
||
</dd></dl>
|
||
<dl compact><dt><b></b></dt><dd>For info on file creation in the case of an already-open file, please refer to the <b>Special</b> <b>case</b> section in the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5F.html#File-Create">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5F.html#File-Create</a> </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="H5::H5File::H5File" ></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::H5File::H5File </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const string & </td>
|
||
<td class="mdname" nowrap> <em>name</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>unsigned int </td>
|
||
<td class="mdname" nowrap> <em>flags</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a></code>, </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>access_plist</em> = <code><a class="el" href="classH5_1_1FileAccPropList.html#s0">FileAccPropList::DEFAULT</a></code></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is another overloaded constructor. It differs from the above constructor only in the type of the <em>name</em> argument.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN: Name of the file - <code>std::string</code> </td></tr>
|
||
<tr><td></td><td valign=top><em>flags</em> </td><td>- IN: File access flags </td></tr>
|
||
<tr><td></td><td valign=top><em>create_plist</em> </td><td>- IN: File creation property list, used when modifying default file meta-data. Default to <a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a> </td></tr>
|
||
<tr><td></td><td valign=top><em>access_plist</em> </td><td>- IN: File access property list. Default to <a class="el" href="classH5_1_1FileCreatPropList.html#s0">FileCreatPropList::DEFAULT</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a20" doxytag="H5::H5File::H5File" ></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::H5File::H5File </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 <a class="el" href="classH5_1_1H5File.html">H5File</a> object.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a21" doxytag="H5::H5File::H5File" ></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::H5File::H5File </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1H5File.html">H5File</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_1H5File.html">H5File</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: <a class="el" href="classH5_1_1H5File.html">H5File</a> instance to copy </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a22" doxytag="H5::H5File::~H5File" ></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::H5File::~<a class="el" href="classH5_1_1H5File.html">H5File</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>
|
||
Properly terminates access to this file.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr><h2>Member Function Documentation</h2>
|
||
<a class="anchor" name="a2" doxytag="H5::H5File::getAccessPlist" ></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::H5File::getAccessPlist </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 access property list of this file.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1FileAccPropList.html">FileAccPropList</a> object </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a3" doxytag="H5::H5File::getCreatePlist" ></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_1FileCreatPropList.html">FileCreatPropList</a> H5::H5File::getCreatePlist </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 creation property list of this file.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1FileCreatPropList.html">FileCreatPropList</a> object </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a4" doxytag="H5::H5File::getFileName" ></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"> string H5::H5File::getFileName </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>
|
||
Gets the name of this file.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>File name </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::IdComponentException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a5" doxytag="H5::H5File::getFileSize" ></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::H5File::getFileSize </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 file size of the HDF5 file.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>File 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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>This function is called after an existing file is opened in order to learn the true size of the underlying file. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a6" doxytag="H5::H5File::getFreeSpace" ></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"> hssize_t H5::H5File::getFreeSpace </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 amount of free space in the file.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Amount of free space </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a7" doxytag="H5::H5File::getObjCount" ></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"> int H5::H5File::getObjCount </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">unsigned </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>types</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>
|
||
Returns the number of opened object IDs (files, datasets, groups and datatypes) in the same file.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>types</em> </td><td>- Type of object to retrieve the count </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Number of opened object IDs </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The valid values for <em>types</em> include: <ul>
|
||
<li><code>H5F_OBJ_FILE</code> Files only </li>
|
||
<li><code>H5F_OBJ_DATASET</code> Datasets only </li>
|
||
<li><code>H5F_OBJ_GROUP</code> Groups only </li>
|
||
<li><code>H5F_OBJ_DATATYPE</code> Named datatypes only </li>
|
||
<li><code>H5F_OBJ_ATTR</code> Attributes only </li>
|
||
<li><code>H5F_OBJ_ALL</code> All of the above </li>
|
||
<li><code></code>(i.e., H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR ) Multiple object types can be combined with the logical OR operator (|). </li>
|
||
</ul>
|
||
</dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a8" doxytag="H5::H5File::getObjCount" ></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"> int H5::H5File::getObjCount </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>
|
||
This is an overloaded member function, provided for convenience. It takes no parameter and returns the object count of all object types.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Number of opened object IDs </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a9" doxytag="H5::H5File::getObjIDs" ></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::H5File::getObjIDs </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">unsigned </td>
|
||
<td class="mdname" nowrap> <em>types</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>int </td>
|
||
<td class="mdname" nowrap> <em>max_objs</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>hid_t * </td>
|
||
<td class="mdname" nowrap> <em>oid_list</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>
|
||
Retrieves a list of opened object IDs (files, datasets, groups and datatypes) in the same file.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>types</em> </td><td>- Type of object to retrieve the count </td></tr>
|
||
<tr><td></td><td valign=top><em>max_objs</em> </td><td>- Maximum number of object identifiers to place into obj_id_list. </td></tr>
|
||
<tr><td></td><td valign=top><em>oid_list</em> </td><td>- List of open object identifiers </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The valid values for <em>types</em> include: <ul>
|
||
<li><code>H5F_OBJ_FILE</code> Files only </li>
|
||
<li><code>H5F_OBJ_DATASET</code> Datasets only </li>
|
||
<li><code>H5F_OBJ_GROUP</code> Groups only </li>
|
||
<li><code>H5F_OBJ_DATATYPE</code> Named datatypes only </li>
|
||
<li><code>H5F_OBJ_ATTR</code> Attributes only </li>
|
||
<li><code>H5F_OBJ_ALL</code> All of the above </li>
|
||
<li><code></code>(I.e., H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR ) Multiple object types can be combined with the logical OR operator (|). </li>
|
||
</ul>
|
||
</dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="H5::H5File::getObjType" ></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"> H5G_obj_t H5::H5File::getObjType </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">void * </td>
|
||
<td class="mdname" nowrap> <em>ref</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5R_type_t </td>
|
||
<td class="mdname" nowrap> <em>ref_type</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>
|
||
Retrieves the type of object that an object reference points to.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>ref</em> </td><td>- IN: Reference to query </td></tr>
|
||
<tr><td></td><td valign=top><em>ref_type</em> </td><td>- IN: Type of reference to query </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Object type, which can be one of the following: <ul>
|
||
<li><code>H5G_LINK</code> - Object is a symbolic link. </li>
|
||
<li><code>H5G_GROUP</code> - Object is a group. </li>
|
||
<li><code>H5G_DATASET</code> - Object is a dataset. </li>
|
||
<li><code>H5G_TYPE</code> - Object is a named datatype </li>
|
||
</ul>
|
||
</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::ReferenceIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a11" doxytag="H5::H5File::getRegion" ></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_1DataSpace.html">DataSpace</a> H5::H5File::getRegion </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">void * </td>
|
||
<td class="mdname" nowrap> <em>ref</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5R_type_t </td>
|
||
<td class="mdname" nowrap> <em>ref_type</em> = <code>H5R_DATASET_REGION</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>
|
||
Retrieves a dataspace with the region pointed to selected.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>ref</em> </td><td>- IN: Reference to get region of </td></tr>
|
||
<tr><td></td><td valign=top><em>ref_type</em> </td><td>- IN: Type of reference to get region of - default </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> instance </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::ReferenceIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a12" doxytag="H5::H5File::getVFDHandle" ></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::H5File::getVFDHandle </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>fapl</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void ** </td>
|
||
<td class="mdname" nowrap> <em>file_handle</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 pointer to the file handle of the low-level 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>fapl</em> </td><td>- File access property list </td></tr>
|
||
<tr><td></td><td valign=top><em>file_handle</em> </td><td>- Pointer to the file handle being used by the low-level virtual file driver </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>For the FAMILY or MULTI drivers, <em>fapl</em> should be defined through the property list functions: <code><a class="el" href="classH5_1_1FileAccPropList.html#a3">FileAccPropList::setFamilyOffset</a></code> for the FAMILY driver and <code><a class="el" href="classH5_1_1FileAccPropList.html#a21">FileAccPropList::setMultiType</a></code> for the MULTI driver.</dd></dl>
|
||
The obtained file handle is dynamic and is valid only while the file remains open; it will be invalid if the file is closed and reopened or opened during a subsequent session. </td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a13" doxytag="H5::H5File::getVFDHandle" ></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::H5File::getVFDHandle </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">void ** </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>file_handle</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.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>file_handle</em> </td><td>- Pointer to the file handle being used by the low-level virtual file driver </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e0" doxytag="H5::H5File::isHdf5" ></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::H5File::isHdf5 </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Determines whether a file in HDF5 format.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN: Name of the file </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>true if the file is in HDF5 format, and false, otherwise </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="e1" doxytag="H5::H5File::isHdf5" ></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::H5File::isHdf5 </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const string & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN: Name of the file - <code>std::string</code> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a14" doxytag="H5::H5File::reOpen" ></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::H5File::reOpen </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>
|
||
Reopens this file.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a15" doxytag="H5::H5File::reopen" ></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::H5File::reopen </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>
|
||
Reopens this file.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>This function will be replaced by the above function <code>reOpen</code> in future releases. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a16" doxytag="H5::H5File::Reference" ></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::H5File::Reference </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname" nowrap> <em>name</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> & </td>
|
||
<td class="mdname" nowrap> <em>dataspace</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5R_type_t </td>
|
||
<td class="mdname" nowrap> <em>ref_type</em> = <code>H5R_DATASET_REGION</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>
|
||
Creates a reference to an Hdf5 object or a dataset region.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN: Name of the object to be referenced </td></tr>
|
||
<tr><td></td><td valign=top><em>dataspace</em> </td><td>- IN: Dataspace with selection </td></tr>
|
||
<tr><td></td><td valign=top><em>ref_type</em> </td><td>- IN: Type of reference; default to <code>H5R_DATASET_REGION</code> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>A reference </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::ReferenceIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Note that, for <a class="el" href="classH5_1_1H5File.html">H5File</a>, name must be an absolute path to the object in the file. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a17" doxytag="H5::H5File::Reference" ></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::H5File::Reference </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>name</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 function, provided for your convenience. It differs from the above function in that it only creates a reference to an HDF5 object, not to a dataset region.
|
||
<p>
|
||
<dl compact><dt><b></b></dt><dd>Note that, for <a class="el" href="classH5_1_1H5File.html">H5File</a>, name must be an absolute path to the object in the file. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a18" doxytag="H5::H5File::throwException" ></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::H5File::throwException </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const string </td>
|
||
<td class="mdname" nowrap> <em>func_name</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>msg</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const<code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Throws file exception - initially implemented for <a class="el" href="classH5_1_1CommonFG.html">CommonFG</a>.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>func_name</em> </td><td>- Name of the function where failure occurs </td></tr>
|
||
<tr><td></td><td valign=top><em>msg</em> </td><td>- Message describing the failure </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::FileIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
|
||
<p>
|
||
Implements <a class="el" href="classH5_1_1CommonFG.html#a45">H5::CommonFG</a>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a19" doxytag="H5::H5File::getLocId" ></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::H5File::getLocId </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<code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
For subclasses, <a class="el" href="classH5_1_1H5File.html">H5File</a> and <a class="el" href="classH5_1_1Group.html">Group</a>, to return the correct object id, i.e. file or group id.
|
||
<p>
|
||
Implements <a class="el" href="classH5_1_1CommonFG.html#a44">H5::CommonFG</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>
|