mirror of
https://github.com/Unidata/netcdf-cxx4.git
synced 2024-12-15 08:39:54 +08:00
130 lines
23 KiB
HTML
130 lines
23 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_wr_formats.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++
|
|
 <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 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 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__wr__formats_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_wr_formats.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* This is part of the netCDF package.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <span class="comment"> See COPYRIGHT file for conditions of use.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This is a very simple example which writes a 2D array of</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> sample data. To handle this in netCDF we create two shared</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> dimensions, "x" and "y", and a netCDF variable, called "data".</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> This example is part of the netCDF tutorial:</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-tutorial</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Full documentation of the netCDF C++ API can be found at:</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-cxx</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> $Id: simple_xy_wr_formats.cpp,v 1.1 2010/04/09 02:15:05 russ Exp $</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">*/</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <netcdf></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">using namespace </span><a class="code" href="namespacenetCDF.html">netCDF</a>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">using namespace </span><a class="code" href="namespacenetCDF_1_1exceptions.html">netCDF::exceptions</a>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// We are writing 2D data, a 6 x 12 grid. </span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NX = 6;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NY = 12;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Return this in event of a problem.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> NC_ERR = 2;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">int</span> create_file(<span class="keywordtype">string</span> filename, <a class="code" href="classnetCDF_1_1NcFile.html#af6c618016efd9b5661b44b6a6a5ed655">NcFile::FileFormat</a> format) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// This is the data array we will write. It will just be filled</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// with a progression of numbers for this example.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">int</span> dataOut[NX][NY];</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Create some pretend data. If this wasn't an example program, we</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// would have some real data to write, for example, model output.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < NX; i++)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> j = 0; j < NY; j++)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  dataOut[i][j] = i * NY + j;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// The default behavior of the C++ API is to throw an exception i</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// an error occurs. A try catch block is necessary.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">try</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  { </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// Create the file. The Replace parameter tells netCDF to overwrite</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// this file, if it already exists. The classic parameter specifies</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// that the file ceated should be in classic format, rather than the</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// default netCDF-4 format used by the cxx4 interface.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classnetCDF_1_1NcFile.html">NcFile</a> dataFile(filename, NcFile::replace, format);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Create netCDF dimensions</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classnetCDF_1_1NcDim.html">NcDim</a> xDim = dataFile.addDim(<span class="stringliteral">"x"</span>, NX);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classnetCDF_1_1NcDim.html">NcDim</a> yDim = dataFile.addDim(<span class="stringliteral">"y"</span>, NY);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Define the variable. The type of the variable in this case is</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// ncInt (32-bit integer).</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  vector<NcDim> dims;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  dims.push_back(xDim);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  dims.push_back(yDim);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classnetCDF_1_1NcVar.html">NcVar</a> data = dataFile.addVar(<span class="stringliteral">"data"</span>, ncInt, dims);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// In the classic model, must explicitly leave define mode</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// before writing data. Need a method that calls nc_enddef().</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">if</span>(format != NcFile::nc4)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  dataFile.enddef();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Write the data to the file. Although netCDF supports</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// reading and writing subsets of data, in this case we write all</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// the data in one operation.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  data.<a class="code" href="classnetCDF_1_1NcVar.html#a2c3206fa2a7b72b8b27912c74edda685">putVar</a>(dataOut);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// The file will be automatically closed when the NcFile object goes</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// out of scope. This frees up any internal netCDF resources</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// associated with the file, and flushes any buffers.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">//cout << "*** SUCCESS writing example file simple_xy.nc!" << endl;</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> 0; </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">catch</span>(<a class="code" href="classnetCDF_1_1exceptions_1_1NcException.html">NcException</a>& e)</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  {e.what();</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> NC_ERR;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">int</span> main()</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">int</span> ret;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span>(ret = create_file(<span class="stringliteral">"simple_xy_nc4.nc"</span>, NcFile::nc4))</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  cout << <span class="stringliteral">"*** SUCCESS creating nc4 file"</span> << endl;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">if</span>(ret = create_file(<span class="stringliteral">"simple_xy_nc4classic.nc"</span>, NcFile::nc4classic))</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  cout << <span class="stringliteral">"*** SUCCESS creating nc4classic file"</span> << endl;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">if</span>(ret = create_file(<span class="stringliteral">"simple_xy_classic.nc"</span>, NcFile::classic))</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  cout << <span class="stringliteral">"*** SUCCESS creating classic file"</span> << endl;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">if</span>(ret = create_file(<span class="stringliteral">"simple_xy_classic64.nc"</span>, NcFile::classic64))</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  cout << <span class="stringliteral">"*** SUCCESS creating classic64 file"</span> << endl;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> }</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="classnetCDF_1_1NcFile_html_af6c618016efd9b5661b44b6a6a5ed655"><div class="ttname"><a href="classnetCDF_1_1NcFile.html#af6c618016efd9b5661b44b6a6a5ed655">netCDF::NcFile::FileFormat</a></div><div class="ttdeci">FileFormat</div><div class="ttdef"><b>Definition:</b> <a href="ncFile_8h_source.html#l00030">ncFile.h:30</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_1NcDim_html"><div class="ttname"><a href="classnetCDF_1_1NcDim.html">netCDF::NcDim</a></div><div class="ttdoc">Class represents a netCDF dimension. </div><div class="ttdef"><b>Definition:</b> <a href="ncDim_8h_source.html#l00013">ncDim.h:13</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_a2c3206fa2a7b72b8b27912c74edda685"><div class="ttname"><a href="classnetCDF_1_1NcVar.html#a2c3206fa2a7b72b8b27912c74edda685">netCDF::NcVar::putVar</a></div><div class="ttdeci">void putVar(const 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#l00815">ncVar.cpp:815</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>
|