<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libdap++: libdap::Error Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libdap++ <span id="projectnumber">Updated for version 3.8.2</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlibdap_1_1Error.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>libdap::Error Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="libdap::Error" -->
<p>A class for error processing.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Error_8h_source.html">Error.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for libdap::Error:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error__inherit__graph.png" border="0" usemap="#libdap_1_1Error_inherit__map" alt="Inheritance graph"/></div>
<map name="libdap_1_1Error_inherit__map" id="libdap_1_1Error_inherit__map">
<area shape="rect" id="node3" href="classlibdap_1_1DDXParseFailed.html" title="{libdap::DDXParseFailed\n||+ DDXParseFailed()\l+ DDXParseFailed()\l}" alt="" coords="5,395,248,487"/><area shape="rect" id="node5" href="classlibdap_1_1InternalErr.html" title="A class for software fault reporting." alt="" coords="272,337,483,546"/><area shape="rect" id="node7" href="classlibdap_1_1ResponseTooBigErr.html" title="{libdap::ResponseTooBigErr\n||+ ResponseTooBigErr()\l+ ResponseTooBigErr()\l}" alt="" coords="507,395,779,487"/><area shape="rect" id="node9" href="classlibdap_1_1SignalHandlerRegisteredErr.html" title="{libdap::SignalHandlerRegisteredErr\n||+ SignalHandlerRegisteredErr()\l+ SignalHandlerRegisteredErr()\l}" alt="" coords="803,395,1165,487"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for libdap::Error:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error__coll__graph.png" border="0" usemap="#libdap_1_1Error_coll__map" alt="Collaboration graph"/></div>
<map name="libdap_1_1Error_coll__map" id="libdap_1_1Error_coll__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classlibdap_1_1Error-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#aa29df17396d7558f61fe0c7d16944221">Error</a> (<a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> ec, string msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a5501a52112b0736474a6fbe31ff35952">Error</a> (string msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a749c827344436b813dc86b6c202069ad">Error</a> (const <a class="el" href="classlibdap_1_1Error.html">Error</a> &copy_from)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a0d75f4244ed27998bf2e5e031bc1bf4b">Error</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a207b7ba3e52b236a5c48440525c99ab8">get_error_code</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a917fdf537b7dd7e587e9cf6dc7e4c687">get_error_message</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e">OK</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object valid? <a href="#a5624b1cca8a752a24d76a50e092fd61e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibdap_1_1Error.html">Error</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a351366d737b8b5899e68599b055fd596">operator=</a> (const <a class="el" href="classlibdap_1_1Error.html">Error</a> &rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#ac705b3c1cfab1f7530d66a974eb0e8b6">parse</a> (FILE *fp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object. <a href="#ac705b3c1cfab1f7530d66a974eb0e8b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#af2185ebeb4236e2902abda772a2b5a49">print</a> (FILE *out) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#ab411acbae4f6592c6ec23760eed622ed">print</a> (ostream &out) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a47c0f4b6a38d8ca075d1056076d2845d">set_error_code</a> (<a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> ec=undefined_error)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#af48fc071e737b88925dfd0bff8995304">set_error_message</a> (string msg="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a746f8a7ae2a12f2c8f5c7b6d0e5c6283">~Error</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a30226017ae9dfbe2e27be502b4fbdef4">_error_code</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Error.html#a86b1ed1e500e2ad6bbcfdd046b870728">_error_message</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> class is used to transport error information from the server to the client within libdap. This class is also the base class for all the errors thrown by methods in the DAP, so catching <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> will catch all DAP throws. Errors consist of an error code and a string. The code can be used to quickly distinguish between certain common errors while the string is used to convey information about the error to the user. The error code should never be displayed to the user.</p>
<p>This class is used on both clients and servers. The <em><a class="el" href="classlibdap_1_1Error.html#af2185ebeb4236e2902abda772a2b5a49">print()</a></em> and <em><a class="el" href="classlibdap_1_1Error.html#ac705b3c1cfab1f7530d66a974eb0e8b6" title="Parse an Error object.">parse()</a></em> methods are used to send the object back and forth.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>A past version of this class supported the notion of an error correcting program (Tcl, Java, ...) that could be sent from the server to the client to help users correct the error and resubmit the request. This never worked well in practice and that feature of the class is deprecated.</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>jhrg </dd></dl>
<p>Definition at line <a class="el" href="Error_8h_source.html#l00090">90</a> of file <a class="el" href="Error_8h_source.html">Error.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa29df17396d7558f61fe0c7d16944221"></a><!-- doxytag: member="libdap::Error::Error" ref="aa29df17396d7558f61fe0c7d16944221" args="(ErrorCode ec, string msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Error::Error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> </td>
<td class="paramname"><em>ec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"><em>msg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance with a specific code and message string. This ctor provides a way to to use any code and string you'd like. The code can be one of the standard codes or it may be specific to your server. Thus a client which can tell it's dealing with a specific type of server can use the code accordingly. In general, clients simply show the error message to users or write it to a log file.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ec</td><td>The error code </td></tr>
<tr><td class="paramname">msg</td><td>The error message string. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00089">89</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5501a52112b0736474a6fbe31ff35952"></a><!-- doxytag: member="libdap::Error::Error" ref="a5501a52112b0736474a6fbe31ff35952" args="(string msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Error::Error </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance with a specific message. The error code is set to <code>unknown_error</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The error message. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f" title="An enumerated type for common errors.">ErrorCode</a> </dd></dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00098">98</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a0d75f4244ed27998bf2e5e031bc1bf4b"></a><!-- doxytag: member="libdap::Error::Error" ref="a0d75f4244ed27998bf2e5e031bc1bf4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Error::Error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specializations of <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> should use this to set the error code and message. </p>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00077">77</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a749c827344436b813dc86b6c202069ad"></a><!-- doxytag: member="libdap::Error::Error" ref="a749c827344436b813dc86b6c202069ad" args="(const Error &copy_from)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Error::Error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlibdap_1_1Error.html">Error</a> & </td>
<td class="paramname"><em>copy_from</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00102">102</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a746f8a7ae2a12f2c8f5c7b6d0e5c6283"></a><!-- doxytag: member="libdap::Error::~Error" ref="a746f8a7ae2a12f2c8f5c7b6d0e5c6283" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Error::~Error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00108">108</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a207b7ba3e52b236a5c48440525c99ab8"></a><!-- doxytag: member="libdap::Error::get_error_code" ref="a207b7ba3e52b236a5c48440525c99ab8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> libdap::Error::get_error_code </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the ErrorCode for this instance. </p>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00250">250</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, and <a class="el" href="Error_8cc_source.html#l00136">OK()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_a207b7ba3e52b236a5c48440525c99ab8_cgraph.png" border="0" usemap="#classlibdap_1_1Error_a207b7ba3e52b236a5c48440525c99ab8_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_a207b7ba3e52b236a5c48440525c99ab8_cgraph" id="classlibdap_1_1Error_a207b7ba3e52b236a5c48440525c99ab8_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="365,5,557,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a917fdf537b7dd7e587e9cf6dc7e4c687"></a><!-- doxytag: member="libdap::Error::get_error_message" ref="a917fdf537b7dd7e587e9cf6dc7e4c687" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string libdap::Error::get_error_message </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current error message. </p>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00279">279</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, and <a class="el" href="Error_8cc_source.html#l00136">OK()</a>.</p>
<p>Referenced by <a class="el" href="HTTPCache_8cc_source.html#l01141">libdap::HTTPCache::cache_response()</a>, <a class="el" href="getdap_8cc_source.html#l00154">main()</a>, <a class="el" href="Error_8cc_source.html#l00159">parse()</a>, and <a class="el" href="HTTPCache_8cc_source.html#l00317">libdap::HTTPCache::~HTTPCache()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_a917fdf537b7dd7e587e9cf6dc7e4c687_cgraph.png" border="0" usemap="#classlibdap_1_1Error_a917fdf537b7dd7e587e9cf6dc7e4c687_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_a917fdf537b7dd7e587e9cf6dc7e4c687_cgraph" id="classlibdap_1_1Error_a917fdf537b7dd7e587e9cf6dc7e4c687_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="397,5,589,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a5624b1cca8a752a24d76a50e092fd61e"></a><!-- doxytag: member="libdap::Error::OK" ref="a5624b1cca8a752a24d76a50e092fd61e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool libdap::Error::OK </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this function to determine whether an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object is valid. To be a valid, an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object must either be: 1) empty or contain a message and a code.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the object is valid, FALSE otherwise. </dd></dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00136">136</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, <a class="el" href="debug_8h_source.html#l00058">DBG</a>, and <a class="el" href="Error_8h_source.html#l00059">undefined_error</a>.</p>
<p>Referenced by <a class="el" href="Error_8cc_source.html#l00250">get_error_code()</a>, <a class="el" href="Error_8cc_source.html#l00279">get_error_message()</a>, <a class="el" href="Error_8cc_source.html#l00113">operator=()</a>, <a class="el" href="Error_8cc_source.html#l00159">parse()</a>, and <a class="el" href="Error_8cc_source.html#l00201">print()</a>.</p>
</div>
</div>
<a class="anchor" id="a351366d737b8b5899e68599b055fd596"></a><!-- doxytag: member="libdap::Error::operator=" ref="a351366d737b8b5899e68599b055fd596" args="(const Error &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlibdap_1_1Error.html">Error</a> & libdap::Error::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlibdap_1_1Error.html">Error</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00113">113</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, and <a class="el" href="Error_8cc_source.html#l00136">OK()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_a351366d737b8b5899e68599b055fd596_cgraph.png" border="0" usemap="#classlibdap_1_1Error_a351366d737b8b5899e68599b055fd596_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_a351366d737b8b5899e68599b055fd596_cgraph" id="classlibdap_1_1Error_a351366d737b8b5899e68599b055fd596_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="317,5,509,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac705b3c1cfab1f7530d66a974eb0e8b6"></a><!-- doxytag: member="libdap::Error::parse" ref="ac705b3c1cfab1f7530d66a974eb0e8b6" args="(FILE *fp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool libdap::Error::parse </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given an input stream (FILE *) <code>fp</code>, parse an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object from stream. Values for fields of the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object are parsed and <code>this</code> is set accordingly. This is how a client program receives an error object from a server.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>A valid file pointer to an input stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if no error was detected, FALSE otherwise. </dd></dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00159">159</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8cc.html#adfec1b31b9c0855ec3f39c9114b085bd">Error_buffer()</a>, <a class="el" href="Error_8cc.html#a6ab0f7ae420eb26a950794dd0c9090d8">Error_delete_buffer()</a>, <a class="el" href="Error_8cc.html#aa1dc432625185fae6933cefeea085d5b">Error_switch_to_buffer()</a>, <a class="el" href="Error_8cc.html#a451f3a09d4697c0ceb2dc1fa9d5caa9c">Errorparse()</a>, <a class="el" href="Error_8cc_source.html#l00279">get_error_message()</a>, <a class="el" href="Error_8cc_source.html#l00136">OK()</a>, and <a class="el" href="parser_8h_source.html#l00101">libdap::parser_arg::status()</a>.</p>
<p>Referenced by <a class="el" href="Connect_8cc_source.html#l00369">libdap::Connect::request_das()</a>, <a class="el" href="Connect_8cc_source.html#l00432">libdap::Connect::request_das_url()</a>, <a class="el" href="Connect_8cc_source.html#l00495">libdap::Connect::request_dds()</a>, <a class="el" href="Connect_8cc_source.html#l00573">libdap::Connect::request_dds_url()</a>, <a class="el" href="Connect_8cc_source.html#l00633">libdap::Connect::request_ddx()</a>, and <a class="el" href="Connect_8cc_source.html#l00706">libdap::Connect::request_ddx_url()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_ac705b3c1cfab1f7530d66a974eb0e8b6_cgraph.png" border="0" usemap="#classlibdap_1_1Error_ac705b3c1cfab1f7530d66a974eb0e8b6_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_ac705b3c1cfab1f7530d66a974eb0e8b6_cgraph" id="classlibdap_1_1Error_ac705b3c1cfab1f7530d66a974eb0e8b6_cgraph">
<area shape="rect" id="node3" href="Error_8cc.html#adfec1b31b9c0855ec3f39c9114b085bd" title="Error_buffer" alt="" coords="379,5,520,32"/><area shape="rect" id="node5" href="Error_8cc.html#a6ab0f7ae420eb26a950794dd0c9090d8" title="Error_delete_buffer" alt="" coords="344,56,555,83"/><area shape="rect" id="node7" href="Error_8cc.html#aa1dc432625185fae6933cefeea085d5b" title="Error_switch_to_buffer" alt="" coords="328,107,571,133"/><area shape="rect" id="node9" href="Error_8cc.html#a451f3a09d4697c0ceb2dc1fa9d5caa9c" title="Errorparse" alt="" coords="388,157,511,184"/><area shape="rect" id="node11" href="classlibdap_1_1Error.html#a917fdf537b7dd7e587e9cf6dc7e4c687" title="libdap::Error::get_error_message" alt="" coords="279,208,620,235"/><area shape="rect" id="node13" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="669,233,861,260"/><area shape="rect" id="node16" href="structlibdap_1_1parser__arg.html#a9d4f550e0ca6188501290d42382e85a2" title="libdap::parser_arg::status" alt="" coords="308,309,591,336"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ab411acbae4f6592c6ec23760eed622ed"></a><!-- doxytag: member="libdap::Error::print" ref="ab411acbae4f6592c6ec23760eed622ed" args="(ostream &out) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Error::print </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"><em>strm</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a printable representation of the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object. It is suitable for framing, and also for printing and sending over a network.</p>
<p>The printed representation produced by this function can be parsed by the <a class="el" href="classlibdap_1_1Error.html#ac705b3c1cfab1f7530d66a974eb0e8b6" title="Parse an Error object.">parse()</a> member function. Thus parse and print form a symmetrical pair that can be used to send and receive an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object over the network in a MIME document.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>A reference to the output stream on which the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object is to be rendered. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00230">230</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, and <a class="el" href="Error_8cc_source.html#l00136">OK()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_ab411acbae4f6592c6ec23760eed622ed_cgraph.png" border="0" usemap="#classlibdap_1_1Error_ab411acbae4f6592c6ec23760eed622ed_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_ab411acbae4f6592c6ec23760eed622ed_cgraph" id="classlibdap_1_1Error_ab411acbae4f6592c6ec23760eed622ed_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="277,5,469,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="af2185ebeb4236e2902abda772a2b5a49"></a><!-- doxytag: member="libdap::Error::print" ref="af2185ebeb4236e2902abda772a2b5a49" args="(FILE *out) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Error::print </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>out</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a printable representation of the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object. It is suitable for framing, and also for printing and sending over a network.</p>
<p>The printed representation produced by this function can be parsed by the <a class="el" href="classlibdap_1_1Error.html#ac705b3c1cfab1f7530d66a974eb0e8b6" title="Parse an Error object.">parse()</a> member function. Thus parse and print form a symmetrical pair that can be used to send and receive an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object over the network in a MIME document.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>A pointer to the output stream on which the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object is to be rendered. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00201">201</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, and <a class="el" href="Error_8cc_source.html#l00136">OK()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Error_af2185ebeb4236e2902abda772a2b5a49_cgraph.png" border="0" usemap="#classlibdap_1_1Error_af2185ebeb4236e2902abda772a2b5a49_cgraph" alt=""/></div>
<map name="classlibdap_1_1Error_af2185ebeb4236e2902abda772a2b5a49_cgraph" id="classlibdap_1_1Error_af2185ebeb4236e2902abda772a2b5a49_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Error.html#a5624b1cca8a752a24d76a50e092fd61e" title="Is the Error object valid?" alt="" coords="277,5,469,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a47c0f4b6a38d8ca075d1056076d2845d"></a><!-- doxytag: member="libdap::Error::set_error_code" ref="a47c0f4b6a38d8ca075d1056076d2845d" args="(ErrorCode ec=undefined_error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Error::set_error_code </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> </td>
<td class="paramname"><em>ec</em> = <code>undefined_error</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the ErrorCode. If the current error message has not been set, use <em>ec</em> to set the error message. The resulting error message string is the same as the ErrorCode name. If <em>ec</em> is not within the range of values for an OPeNDAP ErrorCode, the error message is left unchanged.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ec</td><td>The new ErrorCode value. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00263">263</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00093">_error_code</a>, <a class="el" href="Error_8h_source.html#l00094">_error_message</a>, <a class="el" href="Error_8h_source.html#l00066">cannot_read_file</a>, and <a class="el" href="Error_8h_source.html#l00059">undefined_error</a>.</p>
</div>
</div>
<a class="anchor" id="af48fc071e737b88925dfd0bff8995304"></a><!-- doxytag: member="libdap::Error::set_error_message" ref="af48fc071e737b88925dfd0bff8995304" args="(string msg="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Error::set_error_message </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>msg</em> = <code>""</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the error message. </p>
<p>Definition at line <a class="el" href="Error_8cc_source.html#l00288">288</a> of file <a class="el" href="Error_8cc_source.html">Error.cc</a>.</p>
<p>References <a class="el" href="Error_8h_source.html#l00094">_error_message</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a30226017ae9dfbe2e27be502b4fbdef4"></a><!-- doxytag: member="libdap::Error::_error_code" ref="a30226017ae9dfbe2e27be502b4fbdef4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelibdap.html#a4d08204a35e99e555cda79022648362f">ErrorCode</a> <a class="el" href="classlibdap_1_1Error.html#a30226017ae9dfbe2e27be502b4fbdef4">libdap::Error::_error_code</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Error_8h_source.html#l00093">93</a> of file <a class="el" href="Error_8h_source.html">Error.h</a>.</p>
<p>Referenced by <a class="el" href="Error_8cc_source.html#l00250">get_error_code()</a>, <a class="el" href="InternalErr_8cc_source.html#l00052">libdap::InternalErr::InternalErr()</a>, <a class="el" href="Error_8cc_source.html#l00136">OK()</a>, <a class="el" href="Error_8cc_source.html#l00113">operator=()</a>, <a class="el" href="Error_8cc_source.html#l00201">print()</a>, <a class="el" href="ResponseTooBigErr_8cc_source.html#l00039">libdap::ResponseTooBigErr::ResponseTooBigErr()</a>, <a class="el" href="Error_8cc_source.html#l00263">set_error_code()</a>, and <a class="el" href="SignalHandlerRegisteredErr_8h_source.html#l00047">libdap::SignalHandlerRegisteredErr::SignalHandlerRegisteredErr()</a>.</p>
</div>
</div>
<a class="anchor" id="a86b1ed1e500e2ad6bbcfdd046b870728"></a><!-- doxytag: member="libdap::Error::_error_message" ref="a86b1ed1e500e2ad6bbcfdd046b870728" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="classlibdap_1_1Error.html#a86b1ed1e500e2ad6bbcfdd046b870728">libdap::Error::_error_message</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Error_8h_source.html#l00094">94</a> of file <a class="el" href="Error_8h_source.html">Error.h</a>.</p>
<p>Referenced by <a class="el" href="Error_8cc_source.html#l00279">get_error_message()</a>, <a class="el" href="InternalErr_8cc_source.html#l00057">libdap::InternalErr::InternalErr()</a>, <a class="el" href="Error_8cc_source.html#l00136">OK()</a>, <a class="el" href="Error_8cc_source.html#l00113">operator=()</a>, <a class="el" href="Error_8cc_source.html#l00201">print()</a>, <a class="el" href="ResponseTooBigErr_8cc_source.html#l00044">libdap::ResponseTooBigErr::ResponseTooBigErr()</a>, <a class="el" href="Error_8cc_source.html#l00263">set_error_code()</a>, <a class="el" href="Error_8cc_source.html#l00288">set_error_message()</a>, and <a class="el" href="SignalHandlerRegisteredErr_8h_source.html#l00047">libdap::SignalHandlerRegisteredErr::SignalHandlerRegisteredErr()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Error_8h_source.html">Error.h</a></li>
<li><a class="el" href="Error_8cc_source.html">Error.cc</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelibdap.html">libdap</a> </li>
<li class="navelem"><a class="el" href="classlibdap_1_1Error.html">Error</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for libdap++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
