<!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::Resource 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_1Resource.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>libdap::Resource Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="libdap::Resource" -->
<p>Associate a rule with an ancillary resource.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Resource_8h_source.html">Resource.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for libdap::Resource:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1Resource__coll__graph.png" border="0" usemap="#libdap_1_1Resource_coll__map" alt="Collaboration graph"/></div>
<map name="libdap_1_1Resource_coll__map" id="libdap_1_1Resource_coll__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classlibdap_1_1Resource-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">rule</a> { <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9dba6f45d9ce9f7ef1a86bf61f0b8a0a05e6">overwrite</a>,
<a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9dba57f09b056e2330d476992375e735a2d9">replace</a>,
<a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9dbaab6da0bd4132968a72d1fc30b00eac15">fallback</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>How are ancillary resources used. </p>
<a href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">Resource::rule</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#ac4f619a2d285bb490214f0140fdf8ead">get_rule</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a40775ac6d10e4fbb8d8218b2e2537592">get_url</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a762d0f0c90046fd2ae9cf560d4034853">Resource</a> (const string &u)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a2761a9823e5b26e0160cc1f5377e7f42">Resource</a> (const string &u, const string &r) throw (Error)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#ae00f0e40bbf9b6adad22f7317e760ac8">Resource</a> (const string &u, const <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">rule</a> &r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a4900c98c095abda49d70e302940abbdc">Resource</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a96b702c32c4dd26d303f48c47b1d6748">set_rule</a> (const <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">Resource::rule</a> &r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a369191cef05aefab3c0da0d2c3beb0ed">set_url</a> (const string &u)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#af1c6d2556cf5cc77a823014c1aeccfd6">~Resource</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Resource.html#a1a74855fb08b3d9c092487e988d273b0">operator<<</a> (ostream &os, const <a class="el" href="classlibdap_1_1Resource.html">Resource</a> &r)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Bind an ancillary resource with the rule that should be used when combining it with a primary resource. <a class="el" href="classlibdap_1_1Ancillary.html">Ancillary</a> resources are always specified using URLs. If an ancillary resource is a local file, use <code><a href="file://">file://</a></code> URLs.</p>
<p>Note that operator<< is defined for <a class="el" href="classlibdap_1_1Resource.html" title="Associate a rule with an ancillary resource.">Resource</a> as a function.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>James Gallagher <<a href="mailto:jgallagher@opendap.org">jgallagher@opendap.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00050">50</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ad59dde2f5e40839ae61430f746faa9db"></a><!-- doxytag: member="libdap::Resource::rule" ref="ad59dde2f5e40839ae61430f746faa9db" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">libdap::Resource::rule</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The AIS uses this enumeration to describe how a given ancillary should be merged into a primary data source.</p>
<ul>
<li>
overwrite: Attributes in the ancillary source overwrite those in the primary source. New values are added. </li>
<li>
replace: The ancillary source replaces the primary. All of the Attributes in the primary are removed. </li>
<li>
fallback: The ancillary resource provides a set of fallback values if the primary data source lacks any attributes. Note that this does not apply to individual attributes, but to an entire set. The fallback attributes are used only if the original data source lacks attributes altogether. </li>
</ul>
<dl class="author"><dt><b>Author:</b></dt><dd>James Gallagher <<a href="mailto:jgallagher@opendap.org">jgallagher@opendap.org</a>> </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ad59dde2f5e40839ae61430f746faa9dba6f45d9ce9f7ef1a86bf61f0b8a0a05e6"></a><!-- doxytag: member="overwrite" ref="ad59dde2f5e40839ae61430f746faa9dba6f45d9ce9f7ef1a86bf61f0b8a0a05e6" args="" -->overwrite</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad59dde2f5e40839ae61430f746faa9dba57f09b056e2330d476992375e735a2d9"></a><!-- doxytag: member="replace" ref="ad59dde2f5e40839ae61430f746faa9dba57f09b056e2330d476992375e735a2d9" args="" -->replace</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad59dde2f5e40839ae61430f746faa9dbaab6da0bd4132968a72d1fc30b00eac15"></a><!-- doxytag: member="fallback" ref="ad59dde2f5e40839ae61430f746faa9dbaab6da0bd4132968a72d1fc30b00eac15" args="" -->fallback</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00071">71</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4900c98c095abda49d70e302940abbdc"></a><!-- doxytag: member="libdap::Resource::Resource" ref="a4900c98c095abda49d70e302940abbdc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Resource::Resource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a <a class="el" href="classlibdap_1_1Resource.html" title="Associate a rule with an ancillary resource.">Resource</a> with a null URL and set the combination rule to the default. </p>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00075">75</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="a762d0f0c90046fd2ae9cf560d4034853"></a><!-- doxytag: member="libdap::Resource::Resource" ref="a762d0f0c90046fd2ae9cf560d4034853" args="(const string &u)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Resource::Resource </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>u</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a resource. Set the combination rule to the default value, which is overwrite. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">u</td><td>The ancillary resource URL. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00081">81</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae00f0e40bbf9b6adad22f7317e760ac8"></a><!-- doxytag: member="libdap::Resource::Resource" ref="ae00f0e40bbf9b6adad22f7317e760ac8" args="(const string &u, const rule &r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Resource::Resource </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>u</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">rule</a> & </td>
<td class="paramname"><em>r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a <a class="el" href="classlibdap_1_1Resource.html" title="Associate a rule with an ancillary resource.">Resource</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">u</td><td>The ancillary resource URL. </td></tr>
<tr><td class="paramname">r</td><td>The combination rule. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00087">87</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2761a9823e5b26e0160cc1f5377e7f42"></a><!-- doxytag: member="libdap::Resource::Resource" ref="a2761a9823e5b26e0160cc1f5377e7f42" args="(const string &u, const string &r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::Resource::Resource </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>u</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw (<a class="el" href="classlibdap_1_1Error.html">Error</a>)<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a <a class="el" href="classlibdap_1_1Resource.html" title="Associate a rule with an ancillary resource.">Resource</a>.</p>
<p>Note: If this is used in a callback, make sure to check the value of <code>r</code> before calling this constructor. Exceptions thrown within callbacks are not portable. Valid values are "overwrite", "replace" and "fallback". The constructor accepts "default" as a synonym for "overwrite".</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">u</td><td>The ancillary resource URL. </td></tr>
<tr><td class="paramname">r</td><td>The name of the combination rule. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00100">100</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="af1c6d2556cf5cc77a823014c1aeccfd6"></a><!-- doxytag: member="libdap::Resource::~Resource" ref="af1c6d2556cf5cc77a823014c1aeccfd6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual libdap::Resource::~Resource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00112">112</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac4f619a2d285bb490214f0140fdf8ead"></a><!-- doxytag: member="libdap::Resource::get_rule" ref="ac4f619a2d285bb490214f0140fdf8ead" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">Resource::rule</a> libdap::Resource::get_rule </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return combination rule for this resource. </p>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00129">129</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="a40775ac6d10e4fbb8d8218b2e2537592"></a><!-- doxytag: member="libdap::Resource::get_url" ref="a40775ac6d10e4fbb8d8218b2e2537592" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string libdap::Resource::get_url </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the resource URL. </p>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00116">116</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="a96b702c32c4dd26d303f48c47b1d6748"></a><!-- doxytag: member="libdap::Resource::set_rule" ref="a96b702c32c4dd26d303f48c47b1d6748" args="(const Resource::rule &r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void libdap::Resource::set_rule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlibdap_1_1Resource.html#ad59dde2f5e40839ae61430f746faa9db">Resource::rule</a> & </td>
<td class="paramname"><em>r</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the resource's combination rule. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>The combination rule. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00136">136</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<a class="anchor" id="a369191cef05aefab3c0da0d2c3beb0ed"></a><!-- doxytag: member="libdap::Resource::set_url" ref="a369191cef05aefab3c0da0d2c3beb0ed" args="(const string &u)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void libdap::Resource::set_url </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>u</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the resource URL. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">u</td><td>The resource's URL. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Resource_8h_source.html#l00123">123</a> of file <a class="el" href="Resource_8h_source.html">Resource.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a1a74855fb08b3d9c092487e988d273b0"></a><!-- doxytag: member="libdap::Resource::operator<<" ref="a1a74855fb08b3d9c092487e988d273b0" args="(ostream &os, const Resource &r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ostream& operator<< </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlibdap_1_1Resource.html">Resource</a> & </td>
<td class="paramname"><em>r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write the XML for this resource. This function is defined in AISResoruces. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>Write to this ostream. r The <a class="el" href="classlibdap_1_1Resource.html" title="Associate a rule with an ancillary resource.">Resource</a> to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Resource_8h_source.html">Resource.h</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_1Resource.html">Resource</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>
