<!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::Ancillary 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_1Ancillary.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>libdap::Ancillary Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="libdap::Ancillary" -->
<p><code>#include <<a class="el" href="Ancillary_8h_source.html">Ancillary.h</a>></code></p>
<p><a href="classlibdap_1_1Ancillary-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Ancillary.html#a8030c897d09fdf491c3bf56fcdda4ab1">find_ancillary_file</a> (const string &pathname, const string &ext, const string &dir, const string &file)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a file with ancillary data. <a href="#a8030c897d09fdf491c3bf56fcdda4ab1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Ancillary.html#a2732498600d700e6fb806db2ba39d024">find_group_ancillary_file</a> (const string &pathname, const string &ext)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Ancillary.html#a7644210f5b5e49103dbf7109e7bcb278">read_ancillary_das</a> (<a class="el" href="classlibdap_1_1DAS.html">DAS</a> &das, const string &pathname, const string &dir="", const string &file="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1Ancillary.html#aa1f64793537ff7bf93629c9c8a6be8ea">read_ancillary_dds</a> (<a class="el" href="classlibdap_1_1DDS.html">DDS</a> &dds, const string &pathname, const string &dir="", const string &file="")</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="Ancillary_8h_source.html#l00048">48</a> of file <a class="el" href="Ancillary_8h_source.html">Ancillary.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8030c897d09fdf491c3bf56fcdda4ab1"></a><!-- doxytag: member="libdap::Ancillary::find_ancillary_file" ref="a8030c897d09fdf491c3bf56fcdda4ab1" args="(const string &pathname, const string &ext, const string &dir, const string &file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">builddir build BUILD libdap <a class="el" href="classlibdap_1_1Ancillary.html">Ancillary</a> cc builddir build BUILD libdap <a class="el" href="classlibdap_1_1Ancillary.html">Ancillary</a> cc builddir build BUILD libdap <a class="el" href="classlibdap_1_1Ancillary.html">Ancillary</a> cc string libdap::Ancillary::find_ancillary_file </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>ext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function accepts a dataset path name, and searches for a matching ancillary data file name with a very specific set of search rules, given here:</p>
<pre>
directory filename extension
same same `.'given
given same `.'given
same given `.'given
given given `.'given
</pre><p>Where ``same'' refers to the input dataset pathname, and ``given'' refers to the function arguments.</p>
<p>For example, If you call this function with a dataset name of <code>/a/data</code>, an extension of <code>das</code>, a directory of <code>b</code>, and a filename of <code>ralph</code>, the function will look (in order) for the following files:</p>
<pre>
/a/data.das
/b/data.das
/a/ralph.das
/b/ralph.das
</pre><p>The function will return a string containing the name of the first file in the list that exists, if any.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This code now checks for <code>pathname.ext</code> 3/17/99 jhrg</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pathname</td><td>The input pathname of a dataset. </td></tr>
<tr><td class="paramname">ext</td><td>The input extension the desired file is to have. </td></tr>
<tr><td class="paramname">dir</td><td>The input directory in which the desired file may be found. </td></tr>
<tr><td class="paramname">file</td><td>The input filename the desired file may have. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string containing the pathname of the file found by searching with the given components. If no file was found, the null string is returned. </dd></dl>
<p>Definition at line <a class="el" href="Ancillary_8cc_source.html#l00069">69</a> of file <a class="el" href="Ancillary_8cc_source.html">Ancillary.cc</a>.</p>
<p>References <a class="el" href="debug_8h_source.html#l00058">DBG</a>.</p>
<p>Referenced by <a class="el" href="Ancillary_8cc_source.html#l00196">read_ancillary_das()</a>, and <a class="el" href="Ancillary_8cc_source.html#l00213">read_ancillary_dds()</a>.</p>
</div>
</div>
<a class="anchor" id="a2732498600d700e6fb806db2ba39d024"></a><!-- doxytag: member="libdap::Ancillary::find_group_ancillary_file" ref="a2732498600d700e6fb806db2ba39d024" args="(const string &pathname, const string &ext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string libdap::Ancillary::find_group_ancillary_file </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>ext</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assume that <code>name</code> refers to a file that is one of a group of files which share a common `base' name and differ only by some prefix or suffix digits (e.g. <code>00base</code>, <code>01base</code>, ... or <code>base00</code>, ... have the base name <code>base</code>). This function looks for a file <code>base.ext</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name (full or relative) to one member of a group of files. </td></tr>
<tr><td class="paramname">ext</td><td>The extension of the group's ancillary file. Note that <code>ext</code> should include a period (.) if that needs to separate the base name from the extension. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pathname to the group's ancillary file if found, otherwise the empty string (""). </dd></dl>
<p>Definition at line <a class="el" href="Ancillary_8cc_source.html#l00138">138</a> of file <a class="el" href="Ancillary_8cc_source.html">Ancillary.cc</a>.</p>
<p>References <a class="el" href="debug_8h_source.html#l00058">DBG</a>.</p>
</div>
</div>
<a class="anchor" id="a7644210f5b5e49103dbf7109e7bcb278"></a><!-- doxytag: member="libdap::Ancillary::read_ancillary_das" ref="a7644210f5b5e49103dbf7109e7bcb278" args="(DAS &das, const string &pathname, const string &dir="", const string &file="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Ancillary::read_ancillary_das </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlibdap_1_1DAS.html">DAS</a> & </td>
<td class="paramname"><em>das</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>dir</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>file</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Ancillary_8cc_source.html#l00196">196</a> of file <a class="el" href="Ancillary_8cc_source.html">Ancillary.cc</a>.</p>
<p>References <a class="el" href="debug_8h_source.html#l00058">DBG</a>, and <a class="el" href="Ancillary_8cc_source.html#l00069">find_ancillary_file()</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_1Ancillary_a7644210f5b5e49103dbf7109e7bcb278_cgraph.png" border="0" usemap="#classlibdap_1_1Ancillary_a7644210f5b5e49103dbf7109e7bcb278_cgraph" alt=""/></div>
<map name="classlibdap_1_1Ancillary_a7644210f5b5e49103dbf7109e7bcb278_cgraph" id="classlibdap_1_1Ancillary_a7644210f5b5e49103dbf7109e7bcb278_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Ancillary.html#a8030c897d09fdf491c3bf56fcdda4ab1" title="Find a file with ancillary data." alt="" coords="445,5,848,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aa1f64793537ff7bf93629c9c8a6be8ea"></a><!-- doxytag: member="libdap::Ancillary::read_ancillary_dds" ref="aa1f64793537ff7bf93629c9c8a6be8ea" args="(DDS &dds, const string &pathname, const string &dir="", const string &file="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libdap::Ancillary::read_ancillary_dds </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlibdap_1_1DDS.html">DDS</a> & </td>
<td class="paramname"><em>dds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>dir</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>file</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Ancillary_8cc_source.html#l00213">213</a> of file <a class="el" href="Ancillary_8cc_source.html">Ancillary.cc</a>.</p>
<p>References <a class="el" href="debug_8h_source.html#l00058">DBG</a>, <a class="el" href="Ancillary_8cc_source.html#l00069">find_ancillary_file()</a>, and <a class="el" href="DDS_8cc_source.html#l00858">libdap::DDS::parse()</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_1Ancillary_aa1f64793537ff7bf93629c9c8a6be8ea_cgraph.png" border="0" usemap="#classlibdap_1_1Ancillary_aa1f64793537ff7bf93629c9c8a6be8ea_cgraph" alt=""/></div>
<map name="classlibdap_1_1Ancillary_aa1f64793537ff7bf93629c9c8a6be8ea_cgraph" id="classlibdap_1_1Ancillary_aa1f64793537ff7bf93629c9c8a6be8ea_cgraph">
<area shape="rect" id="node3" href="classlibdap_1_1Ancillary.html#a8030c897d09fdf491c3bf56fcdda4ab1" title="Find a file with ancillary data." alt="" coords="445,5,848,32"/><area shape="rect" id="node5" href="classlibdap_1_1DDS.html#a733c8e49ed42ab47d74afe68056340e6" title="Parse a DDS from a file with the given name." alt="" coords="545,56,748,83"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Ancillary_8h_source.html">Ancillary.h</a></li>
<li><a class="el" href="Ancillary_8cc_source.html">Ancillary.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_1Ancillary.html">Ancillary</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>
