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
759 lines
28 KiB
HTML
759 lines
28 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::IdComponent Class Reference</h1><code>#include <<a class="el" href="H5IdComponent_8h-source.html">H5IdComponent.h</a>></code>
|
||
<p>
|
||
<p>Inheritance diagram for H5::IdComponent:
|
||
<p><center><img src="classH5_1_1IdComponent.png" usemap="#H5::IdComponent_map" border="0" alt=""></center>
|
||
<map name="H5::IdComponent_map">
|
||
<area href="classH5_1_1DataSpace.html" alt="H5::DataSpace" shape="rect" coords="0,56,159,80">
|
||
<area href="classH5_1_1H5File.html" alt="H5::H5File" shape="rect" coords="169,56,328,80">
|
||
<area href="classH5_1_1H5Object.html" alt="H5::H5Object" shape="rect" coords="591,56,750,80">
|
||
<area href="classH5_1_1PropList.html" alt="H5::PropList" shape="rect" coords="1183,56,1342,80">
|
||
<area href="classH5_1_1AbstractDs.html" alt="H5::AbstractDs" shape="rect" coords="169,112,328,136">
|
||
<area href="classH5_1_1DataType.html" alt="H5::DataType" shape="rect" coords="591,112,750,136">
|
||
<area href="classH5_1_1Group.html" alt="H5::Group" shape="rect" coords="760,112,919,136">
|
||
<area href="classH5_1_1DSetCreatPropList.html" alt="H5::DSetCreatPropList" shape="rect" coords="929,112,1088,136">
|
||
<area href="classH5_1_1DSetMemXferPropList.html" alt="H5::DSetMemXferPropList" shape="rect" coords="1098,112,1257,136">
|
||
<area href="classH5_1_1FileAccPropList.html" alt="H5::FileAccPropList" shape="rect" coords="1267,112,1426,136">
|
||
<area href="classH5_1_1FileCreatPropList.html" alt="H5::FileCreatPropList" shape="rect" coords="1436,112,1595,136">
|
||
<area href="classH5_1_1Attribute.html" alt="H5::Attribute" shape="rect" coords="84,168,243,192">
|
||
<area href="classH5_1_1DataSet.html" alt="H5::DataSet" shape="rect" coords="253,168,412,192">
|
||
<area href="classH5_1_1AtomType.html" alt="H5::AtomType" shape="rect" coords="422,168,581,192">
|
||
<area href="classH5_1_1CompType.html" alt="H5::CompType" shape="rect" coords="591,168,750,192">
|
||
<area href="classH5_1_1EnumType.html" alt="H5::EnumType" shape="rect" coords="760,168,919,192">
|
||
<area href="classH5_1_1FloatType.html" alt="H5::FloatType" shape="rect" coords="169,224,328,248">
|
||
<area href="classH5_1_1IntType.html" alt="H5::IntType" shape="rect" coords="338,224,497,248">
|
||
<area href="classH5_1_1PredType.html" alt="H5::PredType" shape="rect" coords="507,224,666,248">
|
||
<area href="classH5_1_1StrType.html" alt="H5::StrType" shape="rect" coords="676,224,835,248">
|
||
</map>
|
||
<a href="classH5_1_1IdComponent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||
<tr><td></td></tr>
|
||
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a0">incRefCount</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increments id reference counter. <a href="#a0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a1">decRefCount</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrements id reference counter. <a href="#a1"></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_1IdComponent.html#a2">getCounter</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference counter to this identifier. <a href="#a2"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a3">noReference</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this object has any references. <a href="#a3"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a4">operator=</a> (const <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> &rhs)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a4"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a5">reset</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset this object by deleting/resetting its reference counter. <a href="#a5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1IdComponent.html#a6">setId</a> (hid_t new_id)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the identifier of this object to a new value. <a href="#a6"></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_1IdComponent.html#a7">IdComponent</a> (const hid_t h5_id)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> object using the id of an existing object. <a href="#a7"></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_1IdComponent.html#a8">IdComponent</a> (const <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> &original)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> object. <a href="#a8"></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_1IdComponent.html#a9">getId</a> () const</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the id of this object. <a href="#a9"></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_1IdComponent.html#a10">~IdComponent</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a10"></a><br></td></tr>
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="a7" doxytag="H5::IdComponent::IdComponent" ></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::IdComponent::IdComponent </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const hid_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>h5_id</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Creates an <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> object using the id of an existing object.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>h5_id</em> </td><td>- IN: Id of an existing 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::DataTypeIException</em> </td><td></td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a8" doxytag="H5::IdComponent::IdComponent" ></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::IdComponent::IdComponent </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>original</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Copy constructor: makes a copy of the original <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> object.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>original</em> </td><td>- IN: <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> instance to copy </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="H5::IdComponent::~IdComponent" ></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::IdComponent::~<a class="el" href="classH5_1_1IdComponent.html">IdComponent</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::IdComponent::incRefCount" ></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::IdComponent::incRefCount </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>
|
||
Increments id reference counter.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="H5::IdComponent::decRefCount" ></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::IdComponent::decRefCount </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>
|
||
Decrements id reference counter.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a2" doxytag="H5::IdComponent::getCounter" ></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::IdComponent::getCounter </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the reference counter to this identifier.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Reference count </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a3" doxytag="H5::IdComponent::noReference" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> bool H5::IdComponent::noReference </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Determines whether this object has any references.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if there is no reference, and <code>false</code>, otherwise. </dd></dl>
|
||
<dl compact><dt><b>Note:</b></dt><dd>This function will be obsolete in the next release. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a4" doxytag="H5::IdComponent::operator=" ></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_1IdComponent.html">IdComponent</a> & H5::IdComponent::operator= </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1IdComponent.html">IdComponent</a> & </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Assignment operator.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>rhs</em> </td><td>- IN: Reference to the existing object </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Reference to <a class="el" href="classH5_1_1IdComponent.html">IdComponent</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::IdComponentException</em> </td><td>when attempt to close the HDF5 object fails </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a5" doxytag="H5::IdComponent::reset" ></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::IdComponent::reset </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>
|
||
Reset this object by deleting/resetting its reference counter.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>HDF5 object id </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a6" doxytag="H5::IdComponent::setId" ></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::IdComponent::setId </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">hid_t </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>new_id</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Sets the identifier of this object to a new value.
|
||
<p>
|
||
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td></td><td valign=top><em>H5::IdComponentException</em> </td><td>when the attempt to close the HDF5 object fails </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Description:</b></dt><dd>The calling routine must reset the id of this object by calling resetIdComponent and passing in the "this" pointer. resetIdComponent ensures that the HDF5 id will be appropriately closed. If only this object references its id, its reference counter will be deleted. A new reference counter is created for the new HDF5 object id. </dd></dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a9" doxytag="H5::IdComponent::getId" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> hid_t H5::IdComponent::getId </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap> const<code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
Returns the id of this object.
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>HDF5 object id </dd></dl>
|
||
|
||
<p>
|
||
Reimplemented in <a class="el" href="classH5_1_1PredType.html#a1">H5::PredType</a>.
|
||
<p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr size="1"><address style="align: right;"><small>Generated on Thu Aug 5 00:22:43 2004 by
|
||
<a href="http://www.doxygen.org/index.html">
|
||
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7-20040718 </small></address>
|
||
</body>
|
||
</html>
|