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
2506 lines
103 KiB
HTML
2506 lines
103 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::CommonFG Class Reference</h1><code>#include <<a class="el" href="H5CommonFG_8h-source.html">H5CommonFG.h</a>></code>
|
||
<p>
|
||
<p>Inheritance diagram for H5::CommonFG:
|
||
<p><center><img src="classH5_1_1CommonFG.png" usemap="#H5::CommonFG_map" border="0" alt=""></center>
|
||
<map name="H5::CommonFG_map">
|
||
<area href="classH5_1_1Group.html" alt="H5::Group" shape="rect" coords="0,56,99,80">
|
||
<area href="classH5_1_1H5File.html" alt="H5::H5File" shape="rect" coords="109,56,208,80">
|
||
</map>
|
||
<a href="classH5_1_1CommonFG-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><a class="el" href="classH5_1_1Group.html">Group</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a0">createGroup</a> (const char *name, size_t size_hint=0) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new group at this location which can be a file or another group. <a href="#a0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1Group.html">Group</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a1">createGroup</a> (const string &name, size_t size_hint=0) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a1"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1Group.html">Group</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a2">openGroup</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing group in a location which can be a file or another group. <a href="#a2"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1Group.html">Group</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a3">openGroup</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a3"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataSet.html">DataSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a4">createDataSet</a> (const char *name, const <a class="el" href="classH5_1_1DataType.html">DataType</a> &data_type, const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> &data_space, const <a class="el" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> &create_plist=<a class="el" href="classH5_1_1DSetCreatPropList.html#s0">DSetCreatPropList::DEFAULT</a>) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new dataset at this location. <a href="#a4"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataSet.html">DataSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a5">createDataSet</a> (const string &name, const <a class="el" href="classH5_1_1DataType.html">DataType</a> &data_type, const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> &data_space, const <a class="el" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> &create_plist=<a class="el" href="classH5_1_1DSetCreatPropList.html#s0">DSetCreatPropList::DEFAULT</a>) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataSet.html">DataSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a6">openDataSet</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing dataset at this location. <a href="#a6"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataSet.html">DataSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a7">openDataSet</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a7"></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_1CommonFG.html#a8">getComment</a> (const char *name, size_t bufsize) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for the specified object. <a href="#a8"></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_1CommonFG.html#a9">getComment</a> (const string &name, size_t bufsize) 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 in that it takes an <code>std::string</code> for <em>name</em>. <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_1CommonFG.html#a10">setComment</a> (const char *name, const char *comment) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets or resets the comment for an object specified by its name. <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_1CommonFG.html#a11">setComment</a> (const string &name, const string &comment) 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 in that it takes an <code>std::string</code> for <em>name</em> and <em>comment</em>. <a href="#a11"></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_1CommonFG.html#a12">getLinkval</a> (const char *name, size_t size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the object that the symbolic link points to. <a href="#a12"></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_1CommonFG.html#a13">getLinkval</a> (const string &name, size_t size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a13"></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_1CommonFG.html#a14">getNumObjs</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of objects in this group. <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_1CommonFG.html#a15">getObjinfo</a> (const char *name, hbool_t follow_link, H5G_stat_t &statbuf) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns information about an object. <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_1CommonFG.html#a16">getObjinfo</a> (const string &name, hbool_t follow_link, H5G_stat_t &statbuf) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a16"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>ssize_t </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a17">getObjnameByIdx</a> (hsize_t idx, string &name, size_t size) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of an object in this group, given the object's index. <a href="#a17"></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_1CommonFG.html#a18">getObjTypeByIdx</a> (hsize_t idx) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of an object in this group, given the object's index. <a href="#a18"></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_1CommonFG.html#a19">getObjTypeByIdx</a> (hsize_t idx, string &type_name) 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 because it also provides the returned object type in text. <a href="#a19"></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_1CommonFG.html#a20">iterateElems</a> (const char *name, int *idx, H5G_iterate_t op, void *op_data)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterates a user's function over the entries of a group. <a href="#a20"></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_1CommonFG.html#a21">iterateElems</a> (const string &name, int *idx, H5G_iterate_t op, void *op_data)</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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a21"></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_1CommonFG.html#a22">link</a> (H5G_link_t link_type, const char *curr_name, const char *new_name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of the specified type from <em>new_name</em> to <em>curr_name</em>. <a href="#a22"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a23">link</a> (H5G_link_t link_type, const string &curr_name, const string &new_name) 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 in that it takes an <code>std::string</code> for <em>curr_name</em> and <em>new_name</em>. <a href="#a23"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a24">unlink</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified name at this location. <a href="#a24"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a25">unlink</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a25"></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_1CommonFG.html#a26">mount</a> (const char *name, <a class="el" href="classH5_1_1H5File.html">H5File</a> &child, <a class="el" href="classH5_1_1PropList.html">PropList</a> &plist) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mounts the file <em>child</em> onto this group. <a href="#a26"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a27">mount</a> (const string &name, <a class="el" href="classH5_1_1H5File.html">H5File</a> &child, <a class="el" href="classH5_1_1PropList.html">PropList</a> &plist) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a27"></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_1CommonFG.html#a28">unmount</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmounts the specified file. <a href="#a28"></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_1CommonFG.html#a29">unmount</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a29"></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_1CommonFG.html#a30">move</a> (const char *src, const char *dst) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Renames an object at this location. <a href="#a30"></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_1CommonFG.html#a31">move</a> (const string &src, const string &dst) 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 in that it takes an <code>std::string</code> for <em>src</em> and <em>dst</em>. <a href="#a31"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataType.html">DataType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a32">openDataType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named generic datatype at this location. <a href="#a32"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1DataType.html">DataType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a33">openDataType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a33"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1EnumType.html">EnumType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a34">openEnumType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named enumeration datatype at this location. <a href="#a34"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1EnumType.html">EnumType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a35">openEnumType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a35"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1CompType.html">CompType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a36">openCompType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named compound datatype at this location. <a href="#a36"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1CompType.html">CompType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a37">openCompType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a37"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1IntType.html">IntType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a38">openIntType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named integer datatype at this location. <a href="#a38"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1IntType.html">IntType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a39">openIntType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a39"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1FloatType.html">FloatType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a40">openFloatType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named floating-point datatype at this location. <a href="#a40"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1FloatType.html">FloatType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a41">openFloatType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a41"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1StrType.html">StrType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a42">openStrType</a> (const char *name) const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the named string datatype at this location. <a href="#a42"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1StrType.html">StrType</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1CommonFG.html#a43">openStrType</a> (const string &name) 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 in that it takes an <code>std::string</code> for <em>name</em>. <a href="#a43"></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_1CommonFG.html#a44">getLocId</a> () const =0</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_1CommonFG.html#a45">throwException</a> (const string func_name, const string msg) const =0</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">For subclasses, <a class="el" href="classH5_1_1H5File.html">H5File</a> and <a class="el" href="classH5_1_1Group.html">Group</a>, to throw appropriate exception. <a href="#a45"></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_1CommonFG.html#a46">CommonFG</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a46"></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_1CommonFG.html#a47">~CommonFG</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a47"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="a46" doxytag="H5::CommonFG::CommonFG" ></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::CommonFG::CommonFG </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.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a47" doxytag="H5::CommonFG::~CommonFG" ></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::CommonFG::~<a class="el" href="classH5_1_1CommonFG.html">CommonFG</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::CommonFG::createGroup" ></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_1Group.html">Group</a> H5::CommonFG::createGroup </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>size_hint</em> = <code>0</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 new group at this location which can be a file or another group.
|
||
<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 group to create </td></tr>
|
||
<tr><td></td><td valign=top><em>size_hint</em> </td><td>- IN: Indicates the number of bytes to reserve for the names that will appear in the group </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1Group.html">Group</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The optional <em>size_hint</em> specifies how much file space to reserve for storing the names that will appear in this new group. If a non-positive value is provided for the <em>size_hint</em> then a default size is chosen. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="H5::CommonFG::createGroup" ></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_1Group.html">Group</a> H5::CommonFG::createGroup </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>size_hint</em> = <code>0</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>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a2" doxytag="H5::CommonFG::openGroup" ></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_1Group.html">Group</a> H5::CommonFG::openGroup </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>
|
||
Opens an existing group in a location which can be a file or another group.
|
||
<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 group to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1Group.html">Group</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a3" doxytag="H5::CommonFG::openGroup" ></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_1Group.html">Group</a> H5::CommonFG::openGroup </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a4" doxytag="H5::CommonFG::createDataSet" ></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_1DataSet.html">DataSet</a> H5::CommonFG::createDataSet </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>const <a class="el" href="classH5_1_1DataType.html">DataType</a> & </td>
|
||
<td class="mdname" nowrap> <em>data_type</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> & </td>
|
||
<td class="mdname" nowrap> <em>data_space</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1DSetCreatPropList.html#s0">DSetCreatPropList::DEFAULT</a></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 new dataset at this location.
|
||
<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 dataset to create </td></tr>
|
||
<tr><td></td><td valign=top><em>data_type</em> </td><td>- IN: Datatype of the dataset </td></tr>
|
||
<tr><td></td><td valign=top><em>data_space</em> </td><td>- IN: Dataspace for the dataset </td></tr>
|
||
<tr><td></td><td valign=top><em>create_plist</em> </td><td>- IN: Creation properly list for the dataset </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1DataSet.html">DataSet</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a5" doxytag="H5::CommonFG::createDataSet" ></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_1DataSet.html">DataSet</a> H5::CommonFG::createDataSet </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>const <a class="el" href="classH5_1_1DataType.html">DataType</a> & </td>
|
||
<td class="mdname" nowrap> <em>data_type</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> & </td>
|
||
<td class="mdname" nowrap> <em>data_space</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const <a class="el" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1DSetCreatPropList.html#s0">DSetCreatPropList::DEFAULT</a></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>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a6" doxytag="H5::CommonFG::openDataSet" ></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_1DataSet.html">DataSet</a> H5::CommonFG::openDataSet </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>
|
||
Opens an existing dataset at this location.
|
||
<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 dataset to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1DataSet.html">DataSet</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a7" doxytag="H5::CommonFG::openDataSet" ></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_1DataSet.html">DataSet</a> H5::CommonFG::openDataSet </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a8" doxytag="H5::CommonFG::getComment" ></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::CommonFG::getComment </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>bufsize</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 comment for the specified object.
|
||
<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 </td></tr>
|
||
<tr><td></td><td valign=top><em>bufsize</em> </td><td>- IN: Length of the comment to retrieve </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Comment string </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a9" doxytag="H5::CommonFG::getComment" ></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::CommonFG::getComment </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>bufsize</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="H5::CommonFG::setComment" ></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::CommonFG::setComment </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>const char * </td>
|
||
<td class="mdname" nowrap> <em>comment</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 or resets the comment for an object specified by its name.
|
||
<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 </td></tr>
|
||
<tr><td></td><td valign=top><em>comment</em> </td><td>- IN: New comment </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>If <em>comment</em> is an empty string or a null pointer, the comment message is removed from the object. Comments should be relatively short, null-terminated, ASCII strings. They can be attached to any object that has an object header, e.g., data sets, groups, named data types, and data spaces, but not symbolic links. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a11" doxytag="H5::CommonFG::setComment" ></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::CommonFG::setComment </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>const string & </td>
|
||
<td class="mdname" nowrap> <em>comment</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em> and <em>comment</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a12" doxytag="H5::CommonFG::getLinkval" ></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::CommonFG::getLinkval </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>size</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the name of the object that the symbolic link 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>name</em> </td><td>- IN: Symbolic link to the object </td></tr>
|
||
<tr><td></td><td valign=top><em>size</em> </td><td>- IN: Maximum number of characters of value to be returned </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Name of the 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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a13" doxytag="H5::CommonFG::getLinkval" ></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::CommonFG::getLinkval </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>size_t </td>
|
||
<td class="mdname" nowrap> <em>size</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a14" doxytag="H5::CommonFG::getNumObjs" ></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::CommonFG::getNumObjs </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 number of objects in this group.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Number of objects </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a15" doxytag="H5::CommonFG::getObjinfo" ></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::CommonFG::getObjinfo </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>hbool_t </td>
|
||
<td class="mdname" nowrap> <em>follow_link</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5G_stat_t & </td>
|
||
<td class="mdname" nowrap> <em>statbuf</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns information about an object.
|
||
<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 </td></tr>
|
||
<tr><td></td><td valign=top><em>follow_link</em> </td><td>- IN: Link flag </td></tr>
|
||
<tr><td></td><td valign=top><em>statbuf</em> </td><td>- OUT: Buffer to return information about the object </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a16" doxytag="H5::CommonFG::getObjinfo" ></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::CommonFG::getObjinfo </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>hbool_t </td>
|
||
<td class="mdname" nowrap> <em>follow_link</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5G_stat_t & </td>
|
||
<td class="mdname" nowrap> <em>statbuf</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a17" doxytag="H5::CommonFG::getObjnameByIdx" ></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"> ssize_t H5::CommonFG::getObjnameByIdx </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname" nowrap> <em>idx</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>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>size_t </td>
|
||
<td class="mdname" nowrap> <em>size</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Retrieves the name of an object in this group, given the object's index.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>idx</em> </td><td>- IN: Transient index of the object </td></tr>
|
||
<tr><td></td><td valign=top><em>name</em> </td><td>- IN/OUT: Retrieved name of the object </td></tr>
|
||
<tr><td></td><td valign=top><em>size</em> </td><td>- IN: Length to retrieve </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Actual size of the object name or 0, if object has no 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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>The value of idx can be any nonnegative number less than the total number of objects in the group, which is returned by the function <code><a class="el" href="classH5_1_1CommonFG.html#a14">CommonFG::getNumObjs</a></code>. Note that this is a transient index; thus, an object may have a different index each time the group is opened. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a18" doxytag="H5::CommonFG::getObjTypeByIdx" ></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::CommonFG::getObjTypeByIdx </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>idx</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 type of an object in this group, given the object's index.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>idx</em> </td><td>- IN: Transient index of the object </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Object type </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a19" doxytag="H5::CommonFG::getObjTypeByIdx" ></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::CommonFG::getObjTypeByIdx </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hsize_t </td>
|
||
<td class="mdname" nowrap> <em>idx</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>string & </td>
|
||
<td class="mdname" nowrap> <em>type_name</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function because it also provides the returned object type in text.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>idx</em> </td><td>- IN: Transient index of the object </td></tr>
|
||
<tr><td></td><td valign=top><em>type_name</em> </td><td>- IN: Object type in text </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Object type </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a20" doxytag="H5::CommonFG::iterateElems" ></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::CommonFG::iterateElems </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>int * </td>
|
||
<td class="mdname" nowrap> <em>idx</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5G_iterate_t </td>
|
||
<td class="mdname" nowrap> <em>op</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>op_data</em></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>
|
||
Iterates a user's function over the entries of a group.
|
||
<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 group to iterate over </td></tr>
|
||
<tr><td></td><td valign=top><em>idx</em> </td><td>- IN/OUT: Starting (IN) and ending (OUT) entry indices </td></tr>
|
||
<tr><td></td><td valign=top><em>op</em> </td><td>- IN : User's function to operate on each entry </td></tr>
|
||
<tr><td></td><td valign=top><em>op_data</em> </td><td>- IN/OUT: Data associated with the operation </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a21" doxytag="H5::CommonFG::iterateElems" ></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::CommonFG::iterateElems </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>int * </td>
|
||
<td class="mdname" nowrap> <em>idx</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>H5G_iterate_t </td>
|
||
<td class="mdname" nowrap> <em>op</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>void * </td>
|
||
<td class="mdname" nowrap> <em>op_data</em></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 an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a22" doxytag="H5::CommonFG::link" ></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::CommonFG::link </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5G_link_t </td>
|
||
<td class="mdname" nowrap> <em>link_type</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const char * </td>
|
||
<td class="mdname" nowrap> <em>curr_name</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const char * </td>
|
||
<td class="mdname" nowrap> <em>new_name</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>
|
||
Creates a link of the specified type from <em>new_name</em> to <em>curr_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>link_type</em> </td><td>- IN: Link type; possible values are <ul>
|
||
<li><code>H5G_LINK_HARD</code> </li>
|
||
<li><code>H5G_LINK_SOFT</code> </li>
|
||
</ul>
|
||
</td></tr>
|
||
<tr><td></td><td valign=top><em>curr_name</em> </td><td>- IN: Name of the existing object if link is a hard link; can be anything for the soft link </td></tr>
|
||
<tr><td></td><td valign=top><em>new_name</em> </td><td>- IN: New name for the object </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description</b></dt><dd>Note that both names are interpreted relative to the specified location. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a23" doxytag="H5::CommonFG::link" ></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::CommonFG::link </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">H5G_link_t </td>
|
||
<td class="mdname" nowrap> <em>link_type</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>curr_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>new_name</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>curr_name</em> and <em>new_name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a24" doxytag="H5::CommonFG::unlink" ></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::CommonFG::unlink </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>
|
||
Removes the specified name at this location.
|
||
<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 removed </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a25" doxytag="H5::CommonFG::unlink" ></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::CommonFG::unlink </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a26" doxytag="H5::CommonFG::mount" ></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::CommonFG::mount </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_1H5File.html">H5File</a> & </td>
|
||
<td class="mdname" nowrap> <em>child</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1PropList.html">PropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>plist</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Mounts the file <em>child</em> onto this group.
|
||
<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 group </td></tr>
|
||
<tr><td></td><td valign=top><em>child</em> </td><td>- IN: File to mount </td></tr>
|
||
<tr><td></td><td valign=top><em>plist</em> </td><td>- IN: Property list to use </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a27" doxytag="H5::CommonFG::mount" ></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::CommonFG::mount </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><a class="el" href="classH5_1_1H5File.html">H5File</a> & </td>
|
||
<td class="mdname" nowrap> <em>child</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap><a class="el" href="classH5_1_1PropList.html">PropList</a> & </td>
|
||
<td class="mdname" nowrap> <em>plist</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a28" doxytag="H5::CommonFG::unmount" ></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::CommonFG::unmount </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>
|
||
Unmounts the specified file.
|
||
<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 to unmount </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a29" doxytag="H5::CommonFG::unmount" ></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::CommonFG::unmount </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a30" doxytag="H5::CommonFG::move" ></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::CommonFG::move </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const char * </td>
|
||
<td class="mdname" nowrap> <em>src</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="md" nowrap align="right"></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const char * </td>
|
||
<td class="mdname" nowrap> <em>dst</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>
|
||
Renames an object at this location.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>src</em> </td><td>- IN: Object's original name </td></tr>
|
||
<tr><td></td><td valign=top><em>dst</em> </td><td>- IN: Object's new name </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>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a31" doxytag="H5::CommonFG::move" ></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::CommonFG::move </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const string & </td>
|
||
<td class="mdname" nowrap> <em>src</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>dst</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an <code>std::string</code> for <em>src</em> and <em>dst</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a32" doxytag="H5::CommonFG::openDataType" ></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_1DataType.html">DataType</a> H5::CommonFG::openDataType </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>
|
||
Opens the named generic datatype at this location.
|
||
<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 datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1DataType.html">DataType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a33" doxytag="H5::CommonFG::openDataType" ></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_1DataType.html">DataType</a> H5::CommonFG::openDataType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a34" doxytag="H5::CommonFG::openEnumType" ></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_1EnumType.html">EnumType</a> H5::CommonFG::openEnumType </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>
|
||
Opens the named enumeration datatype at this location.
|
||
<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 enumeration datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1EnumType.html">EnumType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a35" doxytag="H5::CommonFG::openEnumType" ></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_1EnumType.html">EnumType</a> H5::CommonFG::openEnumType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a36" doxytag="H5::CommonFG::openCompType" ></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_1CompType.html">CompType</a> H5::CommonFG::openCompType </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>
|
||
Opens the named compound datatype at this location.
|
||
<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 compound datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1CompType.html">CompType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a37" doxytag="H5::CommonFG::openCompType" ></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_1CompType.html">CompType</a> H5::CommonFG::openCompType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a38" doxytag="H5::CommonFG::openIntType" ></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_1IntType.html">IntType</a> H5::CommonFG::openIntType </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>
|
||
Opens the named integer datatype at this location.
|
||
<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 integer datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1IntType.html">IntType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a39" doxytag="H5::CommonFG::openIntType" ></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_1IntType.html">IntType</a> H5::CommonFG::openIntType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a40" doxytag="H5::CommonFG::openFloatType" ></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_1FloatType.html">FloatType</a> H5::CommonFG::openFloatType </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>
|
||
Opens the named floating-point datatype at this location.
|
||
<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 floating-point datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1FloatType.html">FloatType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a41" doxytag="H5::CommonFG::openFloatType" ></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_1FloatType.html">FloatType</a> H5::CommonFG::openFloatType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a42" doxytag="H5::CommonFG::openStrType" ></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_1StrType.html">StrType</a> H5::CommonFG::openStrType </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>
|
||
Opens the named string datatype at this location.
|
||
<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 string datatype to open </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1StrType.html">StrType</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::FileIException</em> </td><td>or <a class="el" href="classH5_1_1GroupIException.html">H5::GroupIException</a> </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a43" doxytag="H5::CommonFG::openStrType" ></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_1StrType.html">StrType</a> H5::CommonFG::openStrType </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> 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 in that it takes an <code>std::string</code> for <em>name</em>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a44" doxytag="H5::CommonFG::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"> virtual hid_t H5::CommonFG::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> [pure 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>
|
||
Implemented in <a class="el" href="classH5_1_1H5File.html#a19">H5::H5File</a>, and <a class="el" href="classH5_1_1Group.html#a5">H5::Group</a>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a45" doxytag="H5::CommonFG::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"> virtual void H5::CommonFG::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> [pure 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 throw appropriate exception.
|
||
<p>
|
||
|
||
<p>
|
||
Implemented in <a class="el" href="classH5_1_1H5File.html#a18">H5::H5File</a>, and <a class="el" href="classH5_1_1Group.html#a4">H5::Group</a>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr size="1"><address style="align: right;"><small>Generated on Thu Aug 5 00:22:38 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>
|