Files
hdf5/doc/html/cpplus_RM/classH5_1_1Exception.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

1021 lines
40 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::Exception Class Reference</h1><code>#include &lt;<a class="el" href="H5Exception_8h-source.html">H5Exception.h</a>&gt;</code>
<p>
<p>Inheritance diagram for H5::Exception:
<p><center><img src="classH5_1_1Exception.png" usemap="#H5::Exception_map" border="0" alt=""></center>
<map name="H5::Exception_map">
<area href="classH5_1_1AttributeIException.html" alt="H5::AttributeIException" shape="rect" coords="172,56,334,80">
<area href="classH5_1_1DataSetIException.html" alt="H5::DataSetIException" shape="rect" coords="172,112,334,136">
<area href="classH5_1_1DataSpaceIException.html" alt="H5::DataSpaceIException" shape="rect" coords="172,168,334,192">
<area href="classH5_1_1DataTypeIException.html" alt="H5::DataTypeIException" shape="rect" coords="172,224,334,248">
<area href="classH5_1_1FileIException.html" alt="H5::FileIException" shape="rect" coords="172,280,334,304">
<area href="classH5_1_1GroupIException.html" alt="H5::GroupIException" shape="rect" coords="172,336,334,360">
<area href="classH5_1_1IdComponentException.html" alt="H5::IdComponentException" shape="rect" coords="172,392,334,416">
<area href="classH5_1_1LibraryIException.html" alt="H5::LibraryIException" shape="rect" coords="172,448,334,472">
<area href="classH5_1_1PropListIException.html" alt="H5::PropListIException" shape="rect" coords="172,504,334,528">
<area href="classH5_1_1ReferenceException.html" alt="H5::ReferenceException" shape="rect" coords="172,560,334,584">
</map>
<a href="classH5_1_1Exception-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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#a0">Exception</a> (const string func_name, const string message=<a class="el" href="classH5_1_1Exception.html#t0">DEFAULT_MSG</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an exception with the name of the function, in which the failure occurs, and an optional detailed message. <a href="#a0"></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_1Exception.html#a1">getMajorString</a> (H5E_major_t major_num) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a text string that describes the error specified by a major error number. <a href="#a1"></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_1Exception.html#a2">getMinorString</a> (H5E_minor_t minor_num) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a text string that describes the error specified by a minor error number. <a href="#a2"></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_1Exception.html#a3">getDetailMsg</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the detailed message set at the time the exception is thrown. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#a4">getCDetailMsg</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the detailed message set at the time the exception is thrown. <a href="#a4"></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_1Exception.html#a5">getFuncName</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the function, where the exception is thrown. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#a6">getCFuncName</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the function, where the exception is thrown. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#a7">printError</a> (FILE *stream=NULL) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints the error stack in a default manner. <a href="#a7"></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_1Exception.html#a8">Exception</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <a href="#a8"></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_1Exception.html#a9">Exception</a> (const <a class="el" href="classH5_1_1Exception.html">Exception</a> &amp;orig)</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_1Exception.html">Exception</a> object. <a href="#a9"></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_1Exception.html#a10">~Exception</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Noop destructor. <a href="#a10"></a><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#e0">setAutoPrint</a> (H5E_auto_t &amp;func, void *client_data)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns on the automatic error printing. <a href="#e0"></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_1Exception.html#e1">dontPrint</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns off the automatic error printing from the C library. <a href="#e1"></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_1Exception.html#e2">getAutoPrint</a> (H5E_auto_t &amp;func, void **client_data)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the current settings for the automatic error stack traversal function and its data. <a href="#e2"></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_1Exception.html#e3">clearErrorStack</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the error stack for the current thread. <a href="#e3"></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_1Exception.html#e4">walkErrorStack</a> (H5E_direction_t direction, H5E_walk_t func, void *client_data)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Walks the error stack for the current thread, calling the specified function. <a href="#e4"></a><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classH5_1_1Exception.html#t0">DEFAULT_MSG</a></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="H5::Exception::Exception" ></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::Exception::Exception </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const string&nbsp;</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&nbsp;</td>
<td class="mdname" nowrap> <em>message</em> = <code><a class="el" href="classH5_1_1Exception.html#t0">DEFAULT_MSG</a></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>
Creates an exception with the name of the function, in which the failure occurs, and an optional detailed message.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>func_name</em>&nbsp;</td><td>- IN: Name of the function where failure occurs </td></tr>
<tr><td></td><td valign=top><em>message</em>&nbsp;</td><td>- IN: Message on the failure </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="H5::Exception::Exception" ></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::Exception::Exception </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="H5::Exception::Exception" ></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::Exception::Exception </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classH5_1_1Exception.html">Exception</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>orig</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_1Exception.html">Exception</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>orig</em>&nbsp;</td><td>- IN: <a class="el" href="classH5_1_1Exception.html">Exception</a> instance to copy </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="H5::Exception::~Exception" ></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::Exception::~<a class="el" href="classH5_1_1Exception.html">Exception</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="a1" doxytag="H5::Exception::getMajorString" ></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::Exception::getMajorString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5E_major_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>err_major</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>
Returns a text string that describes the error specified by a major error number.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>err_major</em>&nbsp;</td><td>- IN: Major error number </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Major error string </dd></dl>
<dl compact><dt><b>Description</b></dt><dd>In the failure case, the string "Invalid major error number" will be returned. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="H5::Exception::getMinorString" ></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::Exception::getMinorString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5E_minor_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>err_minor</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>
Returns a text string that describes the error specified by a minor error number.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>err_minor</em>&nbsp;</td><td>- IN: Minor error number </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Minor error string </dd></dl>
<dl compact><dt><b>Description</b></dt><dd>In the failure case, the string "Invalid minor error number" will be returned. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="H5::Exception::getDetailMsg" ></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::Exception::getDetailMsg </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 detailed message set at the time the exception is thrown.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Text message - <code>std::string</code> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="H5::Exception::getCDetailMsg" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const char * H5::Exception::getCDetailMsg </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 detailed message set at the time the exception is thrown.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Text message - <code>char</code> pointer </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="H5::Exception::getFuncName" ></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::Exception::getFuncName </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 name of the function, where the exception is thrown.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Text message - <code>std::string</code> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="H5::Exception::getCFuncName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const char * H5::Exception::getCFuncName </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 name of the function, where the exception is thrown.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Text message - <code>char</code> pointer </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="H5::Exception::setAutoPrint" ></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::Exception::setAutoPrint </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5E_auto_t &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>func</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap> <em>client_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Turns on the automatic error printing.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>func</em>&nbsp;</td><td>- IN: Function to be called upon an error condition </td></tr>
<tr><td></td><td valign=top><em>client_data</em>&nbsp;</td><td>- IN: Data passed to the error function </td></tr>
</table>
</dl>
<dl compact><dt><b>Description</b></dt><dd>When the library is first initialized the auto printing function, <em>func</em>, is set to the C API <code>H5Eprint</code> and <em>client_data</em> is the standard error stream pointer, <code>stderr</code>. Automatic stack traversal is always in the <code>H5E_WALK_DOWNWARD</code> direction. </dd></dl>
<dl compact><dt><b></b></dt><dd>Users are encouraged to write their own more specific error handlers </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e1" doxytag="H5::Exception::dontPrint" ></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::Exception::dontPrint </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> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Turns off the automatic error printing from the C library.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e2" doxytag="H5::Exception::getAutoPrint" ></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::Exception::getAutoPrint </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5E_auto_t &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>func</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void **&nbsp;</td>
<td class="mdname" nowrap> <em>client_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieves the current settings for the automatic error stack traversal function and its data.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>func</em>&nbsp;</td><td>- OUT: Current setting for the function to be called upon an error condition </td></tr>
<tr><td></td><td valign=top><em>client_data</em>&nbsp;</td><td>- OUT: Current setting for the data passed to the error function </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e3" doxytag="H5::Exception::clearErrorStack" ></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::Exception::clearErrorStack </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> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Clears the error stack for the current thread.
<p>
<dl compact><dt><b>Description</b></dt><dd>The stack is also cleared whenever a C API function is called, with certain exceptions (for instance, <code>H5Eprint</code>). </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e4" doxytag="H5::Exception::walkErrorStack" ></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::Exception::walkErrorStack </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">H5E_direction_t&nbsp;</td>
<td class="mdname" nowrap> <em>direction</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>H5E_walk_t&nbsp;</td>
<td class="mdname" nowrap> <em>func</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap> <em>client_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Walks the error stack for the current thread, calling the specified function.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>direction</em>&nbsp;</td><td>- IN: Direction in which the error stack is to be walked </td></tr>
<tr><td></td><td valign=top><em>func</em>&nbsp;</td><td>- IN: Function to be called for each error encountered </td></tr>
<tr><td></td><td valign=top><em>client_data</em>&nbsp;</td><td>- IN: Data passed to the error function </td></tr>
</table>
</dl>
<dl compact><dt><b>Description</b></dt><dd>Valid values for <em>direction</em> include: <ul>
<li><code>H5E_WALK_UPWARD</code> - begin with the most specific error and end at the API </li>
<li><code>H5E_WALK_DOWNWARD</code> - begin at the API and end at the inner-most function where the error was first detected </li>
</ul>
</dd></dl>
<dl compact><dt><b></b></dt><dd>The function specified by <em>func</em> will be called for each error in the error stack. The <code>H5E_walk_t</code> prototype is as follows: <div class="fragment"><pre> <span class="keyword">typedef</span> herr_t (*H5E_walk_t)(<span class="keywordtype">int</span> n, H5E_error_t *err_desc, <span class="keywordtype">void</span> *client_data)
<span class="keywordtype">int</span> n - Indexed position of the error in the stack; it begins at zero
regardless of stack traversal direction
H5E_error_t *err_desc - Pointer to a data structure describing the
error. This structure is listed below.
<span class="keywordtype">void</span> *client_data - Pointer to client data in the format expected by
the user-defined function.
</pre></div></dd></dl>
<dl compact><dt><b></b></dt><dd>Data structure to describe the error: <div class="fragment"><pre> <span class="keyword">typedef</span> <span class="keyword">struct </span>H5E_error_t {
hid_t cls_id; <span class="comment">//class ID</span>
hid_t maj_num; <span class="comment">//major error ID</span>
hid_t min_num; <span class="comment">//minor error number</span>
<span class="keyword">const</span> <span class="keywordtype">char</span> *func_name; <span class="comment">//function in which error occurred</span>
<span class="keyword">const</span> <span class="keywordtype">char</span> *file_name; <span class="comment">//file in which error occurred</span>
<span class="keywordtype">unsigned</span> line; <span class="comment">//line in file where error occurs</span>
<span class="keyword">const</span> <span class="keywordtype">char</span> *desc; <span class="comment">//optional supplied description</span>
} H5E_error_t;
</pre></div></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="H5::Exception::printError" ></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::Exception::printError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">FILE *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>stream</em> = <code>NULL</code> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Prints the error stack in a default manner.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stream</em>&nbsp;</td><td>- IN: File pointer </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="t0" doxytag="H5::Exception::DEFAULT_MSG" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const string <a class="el" href="classH5_1_1Exception.html#t0">H5::Exception::DEFAULT_MSG</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<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>