netcdf-cxx4/simple__xy__rd_8cpp_source.html
2016-11-11 15:38:10 -07:00

129 lines
16 KiB
HTML

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>NetCDF-C++: simple_xy_rd.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="netcdf-50x50.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">NetCDF-C++
&#160;<span id="projectnumber">4.3.1-developer</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>NetCDF&#160;Documentation</span></a></li>
<li><a href="pages.html"><span>Navigation</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>Source&#160;Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('simple__xy__rd_8cpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">simple_xy_rd.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This is part of the netCDF package.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> Copyright 2006 University Corporation for Atmospheric Research/Unidata.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> See COPYRIGHT file for conditions of use.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> This is a very simple example which reads a 2D array of</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> sample data produced by simple_xy_wr.cpp.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> This example is part of the netCDF tutorial:</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-tutorial</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> Full documentation of the netCDF C++ API can be found at:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-cxx</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> $Id: simple_xy_rd.cpp,v 1.5 2010/02/11 22:36:43 russ Exp $</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;netcdf&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacenetCDF.html">netCDF</a>;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacenetCDF_1_1exceptions.html">netCDF::exceptions</a>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// We are reading 2D data, a 6 x 12 grid. </span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NX = 6;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NY = 12;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">// Return this in event of a problem.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NC_ERR = 2;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keywordtype">int</span> main()</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// This is the array we will read.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">int</span> dataIn[NX][NY]; </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// Open the file for read access</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classnetCDF_1_1NcFile.html">NcFile</a> dataFile(<span class="stringliteral">&quot;simple_xy.nc&quot;</span>, NcFile::read);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Retrieve the variable named &quot;data&quot;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classnetCDF_1_1NcVar.html">NcVar</a> data=dataFile.<a class="code" href="classnetCDF_1_1NcVar.html#acfb10fba7aa386e06551039bddd555c3">getVar</a>(<span class="stringliteral">&quot;data&quot;</span>);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span>(data.<a class="code" href="classnetCDF_1_1NcVar.html#abff3856710bf8ea8ddc4a01b52a61c88">isNull</a>()) <span class="keywordflow">return</span> NC_ERR;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; data.<a class="code" href="classnetCDF_1_1NcVar.html#acfb10fba7aa386e06551039bddd555c3">getVar</a>(dataIn);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Check the values. </span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; NX; i++)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; NY; j++)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">if</span> (dataIn[i][j] != i * NY + j)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> NC_ERR;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// The netCDF file is automatically closed by the NcFile destructor</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">//cout &lt;&lt; &quot;*** SUCCESS reading example file simple_xy.nc!&quot; &lt;&lt; endl;</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }<span class="keywordflow">catch</span>(<a class="code" href="classnetCDF_1_1exceptions_1_1NcException.html">NcException</a>&amp; e)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; e.what();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; cout&lt;&lt;<span class="stringliteral">&quot;FAILURE*************************************&quot;</span>&lt;&lt;endl;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> NC_ERR;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div><div class="ttc" id="namespacenetCDF_html"><div class="ttname"><a href="namespacenetCDF.html">netCDF</a></div><div class="ttdoc">C++ API for netCDF4. </div><div class="ttdef"><b>Definition:</b> <a href="ncAtt_8h_source.html#l00009">ncAtt.h:9</a></div></div>
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
<div class="ttc" id="namespacenetCDF_1_1exceptions_html"><div class="ttname"><a href="namespacenetCDF_1_1exceptions.html">netCDF::exceptions</a></div><div class="ttdoc">Exception classes. </div><div class="ttdef"><b>Definition:</b> <a href="ncException_8h_source.html#l00015">ncException.h:15</a></div></div>
<div class="ttc" id="classnetCDF_1_1NcVar_html_abff3856710bf8ea8ddc4a01b52a61c88"><div class="ttname"><a href="classnetCDF_1_1NcVar.html#abff3856710bf8ea8ddc4a01b52a61c88">netCDF::NcVar::isNull</a></div><div class="ttdeci">bool isNull() const </div><div class="ttdoc">Returns true if this object variable is not defined. </div><div class="ttdef"><b>Definition:</b> <a href="ncVar_8h_source.html#l00112">ncVar.h:112</a></div></div>
<div class="ttc" id="classnetCDF_1_1NcVar_html_acfb10fba7aa386e06551039bddd555c3"><div class="ttname"><a href="classnetCDF_1_1NcVar.html#acfb10fba7aa386e06551039bddd555c3">netCDF::NcVar::getVar</a></div><div class="ttdeci">void getVar(void *dataValues) const </div><div class="ttdoc">This is an overloaded member function, provided for convenience. </div><div class="ttdef"><b>Definition:</b> <a href="ncVar_8cpp_source.html#l01439">ncVar.cpp:1439</a></div></div>
<div class="ttc" id="classnetCDF_1_1exceptions_1_1NcException_html"><div class="ttname"><a href="classnetCDF_1_1exceptions_1_1NcException.html">netCDF::exceptions::NcException</a></div><div class="ttdoc">Base object is thrown if a netCDF exception is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="ncException_8h_source.html#l00024">ncException.h:24</a></div></div>
<div class="ttc" id="classnetCDF_1_1NcVar_html"><div class="ttname"><a href="classnetCDF_1_1NcVar.html">netCDF::NcVar</a></div><div class="ttdoc">Class represents a netCDF variable. </div><div class="ttdef"><b>Definition:</b> <a href="ncVar_8h_source.html#l00033">ncVar.h:33</a></div></div>
<div class="ttc" id="classnetCDF_1_1NcFile_html"><div class="ttname"><a href="classnetCDF_1_1NcFile.html">netCDF::NcFile</a></div><div class="ttdoc">Class represents a netCDF root group. </div><div class="ttdef"><b>Definition:</b> <a href="ncFile_8h_source.html#l00018">ncFile.h:18</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<hr size="2"/>
<address style="text-align: center;">
<a href="http://www.unidata.ucar.edu/software/netcdf/">Return to the Main Unidata NetCDF page.</a><br>
<img src="http://www.unidata.ucar.edu/images/logos/uniLogo.png">
<address style="text-align: right;"><small>
Generated on Fri Nov 11 2016 15:28:29 for NetCDF-C++. NetCDF is
a <a href="http://www.unidata.ucar.edu/">Unidata</a> library.</small></address>
</body>
</html>