Files
hdf5/doc/html/cpplus_RM/classH5_1_1H5Object.html
Frank Baker c17fb6fa1d [svn-r9028]
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
2004-08-05 16:22:19 -05:00

931 lines
38 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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>&nbsp;</o:p></p>
<p class=MsoNormal><o:p>&nbsp;</o:p></p>
<p class=MsoNormal><o:p>&nbsp;</o:p></p>
</div>
</body>
</html>
<!-- Generated by Doxygen 1.3.7-20040718 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>H5::H5Object Class Reference</h1><code>#include &lt;<a class="el" href="H5Object_8h-source.html">H5Object.h</a>&gt;</code>
<p>
<p>Inheritance diagram for H5::H5Object:
<p><center><img src="classH5_1_1H5Object.png" usemap="#H5::H5Object_map" border="0" alt=""></center>
<map name="H5::H5Object_map">
<area href="classH5_1_1IdComponent.html" alt="H5::IdComponent" shape="rect" coords="351,0,458,24">
<area href="classH5_1_1AbstractDs.html" alt="H5::AbstractDs" shape="rect" coords="58,112,165,136">
<area href="classH5_1_1DataType.html" alt="H5::DataType" shape="rect" coords="351,112,458,136">
<area href="classH5_1_1Group.html" alt="H5::Group" shape="rect" coords="468,112,575,136">
<area href="classH5_1_1Attribute.html" alt="H5::Attribute" shape="rect" coords="0,168,107,192">
<area href="classH5_1_1DataSet.html" alt="H5::DataSet" shape="rect" coords="117,168,224,192">
<area href="classH5_1_1AtomType.html" alt="H5::AtomType" shape="rect" coords="234,168,341,192">
<area href="classH5_1_1CompType.html" alt="H5::CompType" shape="rect" coords="351,168,458,192">
<area href="classH5_1_1EnumType.html" alt="H5::EnumType" shape="rect" coords="468,168,575,192">
<area href="classH5_1_1FloatType.html" alt="H5::FloatType" shape="rect" coords="58,224,165,248">
<area href="classH5_1_1IntType.html" alt="H5::IntType" shape="rect" coords="175,224,282,248">
<area href="classH5_1_1PredType.html" alt="H5::PredType" shape="rect" coords="292,224,399,248">
<area href="classH5_1_1StrType.html" alt="H5::StrType" shape="rect" coords="409,224,516,248">
</map>
<a href="classH5_1_1H5Object-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_1Attribute.html">Attribute</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a0">createAttribute</a> (const char *name, const <a class="el" href="classH5_1_1DataType.html">DataType</a> &amp;type, const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> &amp;space, const <a class="el" href="classH5_1_1PropList.html">PropList</a> &amp;create_plist=<a class="el" href="classH5_1_1PropList.html#s0">PropList::DEFAULT</a>) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an attribute for a group, dataset, or named datatype. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1Attribute.html">Attribute</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a1">createAttribute</a> (const string &amp;name, const <a class="el" href="classH5_1_1DataType.html">DataType</a> &amp;type, const <a class="el" href="classH5_1_1DataSpace.html">DataSpace</a> &amp;space, const <a class="el" href="classH5_1_1PropList.html">PropList</a> &amp;create_plist=<a class="el" href="classH5_1_1PropList.html#s0">PropList::DEFAULT</a>) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to 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_1Attribute.html">Attribute</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a2">openAttribute</a> (const char *name) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Opens an attribute given its name. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1Attribute.html">Attribute</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a3">openAttribute</a> (const string &amp;name) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to 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_1Attribute.html">Attribute</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a4">openAttribute</a> (const unsigned int idx) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Opens an attribute given its index. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a5">flush</a> (H5F_scope_t scope) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flushes all buffers associated with a file to disk. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a6">getFileName</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the name of the file, in which this HDF5 object belongs. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a7">getNumAttrs</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of attributes attached to this HDF5 object. <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a8">iterateAttrs</a> (attr_operator_t user_op, unsigned *idx=NULL, void *op_data=NULL)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iterates a user's function over all the attributes of an <a class="el" href="namespaceH5.html">H5</a> object, which may be a group, dataset or named datatype. <a href="#a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a9">removeAttr</a> (const char *name) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes the named attribute from this object. <a href="#a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a10">removeAttr</a> (const string &amp;name) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an <code>std::string</code> for <em>name</em>. <a href="#a10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a11">H5Object</a> (const <a class="el" href="classH5_1_1H5Object.html">H5Object</a> &amp;original)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1H5Object.html">H5Object</a> instance. <a href="#a11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1H5Object.html#a12">~H5Object</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Noop destructor. <a href="#a12"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a11" doxytag="H5::H5Object::H5Object" ></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::H5Object::H5Object </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1H5Object.html">H5Object</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>original</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1H5Object.html">H5Object</a> instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>original</em>&nbsp;</td><td>- IN: <a class="el" href="classH5_1_1H5Object.html">H5Object</a> instance to copy </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a12" doxytag="H5::H5Object::~H5Object" ></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::H5Object::~<a class="el" href="classH5_1_1H5Object.html">H5Object</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Noop destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="H5::H5Object::createAttribute" ></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_1Attribute.html">Attribute</a> H5::H5Object::createAttribute </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</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> &amp;&nbsp;</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> &amp;&nbsp;</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_1PropList.html">PropList</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1PropList.html#s0">PropList::DEFAULT</a></code></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Creates an attribute for a group, dataset, or named datatype.
<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>&nbsp;</td><td>- IN: Name of the attribute </td></tr>
<tr><td></td><td valign=top><em>data_type</em>&nbsp;</td><td>- IN: Datatype for the attribute </td></tr>
<tr><td></td><td valign=top><em>data_space</em>&nbsp;</td><td>- IN: Dataspace for the attribute - only simple dataspaces are allowed at this time </td></tr>
<tr><td></td><td valign=top><em>create_plist</em>&nbsp;</td><td>- IN: Creation property list - default to <a class="el" href="classH5_1_1PropList.html#s0">PropList::DEFAULT</a> </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1Attribute.html">Attribute</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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>Description</b></dt><dd>The attribute name specified in <em>name</em> must be unique. Attempting to create an attribute with the same name as an existing attribute will raise an exception, leaving the pre-existing attribute intact. To overwrite an existing attribute with a new attribute of the same name, first delete the existing one with <code><a class="el" href="classH5_1_1H5Object.html#a9">H5Object::removeAttr</a></code>, then recreate it with this function. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="H5::H5Object::createAttribute" ></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_1Attribute.html">Attribute</a> H5::H5Object::createAttribute </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const string &amp;&nbsp;</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> &amp;&nbsp;</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> &amp;&nbsp;</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_1PropList.html">PropList</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>create_plist</em> = <code><a class="el" href="classH5_1_1PropList.html#s0">PropList::DEFAULT</a></code></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an <code>std::string</code> for <em>name</em>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="H5::H5Object::openAttribute" ></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_1Attribute.html">Attribute</a> H5::H5Object::openAttribute </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Opens an attribute given 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>&nbsp;</td><td>- IN: Name of the attribute </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1Attribute.html">Attribute</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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="H5::H5Object::openAttribute" ></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_1Attribute.html">Attribute</a> H5::H5Object::openAttribute </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an <code>std::string</code> for <em>name</em>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="H5::H5Object::openAttribute" ></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_1Attribute.html">Attribute</a> H5::H5Object::openAttribute </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const unsigned int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>idx</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Opens an attribute given its 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>&nbsp;</td><td>- IN: Index of the attribute, a 0-based, non-negative integer </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classH5_1_1Attribute.html">Attribute</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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="H5::H5Object::flush" ></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::H5Object::flush </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5F_scope_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>scope</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flushes all buffers associated with a file to disk.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>scope</em>&nbsp;</td><td>- IN: Specifies the scope of the flushing action, which can be either of these values: <ul>
<li><code>H5F_SCOPE_GLOBAL</code> - Flushes the entire virtual file </li>
<li><code>H5F_SCOPE_LOCAL</code> - Flushes only the specified file </li>
</ul>
</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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>Description</b></dt><dd>This object is used to identify the file to be flushed. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="H5::H5Object::getFileName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string H5::H5Object::getFileName </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets the name of the file, in which this HDF5 object belongs.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>File name </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>H5::IdComponentException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="H5::H5Object::getNumAttrs" ></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::H5Object::getNumAttrs </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the number of attributes attached to this HDF5 object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Number of attributes </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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="H5::H5Object::iterateAttrs" ></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::H5Object::iterateAttrs </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">attr_operator_t&nbsp;</td>
<td class="mdname" nowrap> <em>user_op</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>unsigned *&nbsp;</td>
<td class="mdname" nowrap> <em>idx</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap> <em>op_data</em> = <code>NULL</code></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Iterates a user's function over all the attributes of an <a class="el" href="namespaceH5.html">H5</a> object, which may be a group, dataset or named datatype.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>user_op</em>&nbsp;</td><td>- IN: User's function to operate on each attribute </td></tr>
<tr><td></td><td valign=top><em>idx</em>&nbsp;</td><td>- IN/OUT: Starting (IN) and ending (OUT) attribute indices </td></tr>
<tr><td></td><td valign=top><em>op_data</em>&nbsp;</td><td>- IN: User's data to pass to user's operator function </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returned value of the last operator if it was non-zero, or zero if all attributes were processed </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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>Description</b></dt><dd>For information, please refer to the C layer Reference Manual at: <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5A.html#Annot-Iterate">http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5A.html#Annot-Iterate</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="H5::H5Object::removeAttr" ></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::H5Object::removeAttr </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Removes the named attribute from this 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>&nbsp;</td><td>- IN: Name of the attribute 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::AttributeIException</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="H5::H5Object::removeAttr" ></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::H5Object::removeAttr </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an <code>std::string</code> for <em>name</em>.
<p>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Aug 5 00:22:44 2004 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7-20040718 </small></address>
</body>
</html>