mirror of
https://github.com/Unidata/netcdf-cxx4.git
synced 2025-03-07 19:16:42 +08:00
131 lines
7.8 KiB
HTML
131 lines
7.8 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++: netCDF C++ Interface Guide</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 class="current"><a href="index.html"><span>NetCDF Documentation</span></a></li>
|
|
<li><a href="pages.html"><span>Navigation</span></a></li>
|
|
<li><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><!-- 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('index.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"><a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> C++ Interface Guide </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> C++ Interface Guide</h1>
|
|
<h2>Introduction</h2>
|
|
<p>Lynton Appel, of the Culham Centre for Fusion Energy (CCFE) in Oxfordshire, has developed and contributed a netCDF-4 C++ library that depends on an installed netCDF-4 C library. The netCDF-4 C++ API was developed for use in managing fusion research data from CCFE's innovative MAST (Mega Amp Spherical Tokamak) experiment.</p>
|
|
<p>Appel's C++ implementation is a complete read/write interface for netCDF-4, but can also be used as an alternative to the older netCDF-3 C++ interface, to write classic-format netCDF-3 files as well as netCDF-4 classic model files. The new API is implemented as a layer over the netCDF-4 C interface, which means bug fixes and performance enhancements in the C interface will be immediately available to C++ developers as well. It replaces a previous partial netCDF-4 C++ interface developed by Shanna Forbes.</p>
|
|
<p>The new API makes use of standard C++ features such as namespaces, exceptions, and templates, none of which were included in the first netCDF-3 C++ API developed in the mid-90's. The earlier netCDF-3 C++ API is still supported and available in the source distribution, but devvelopers who are thinking of eventually upgrading to use of the enhanced data model should consider using Lynton's new API.</p>
|
|
<p>We're grateful for Appel's development and CCFE's contribution of the new open-source code for the netCDF-4 C++ API, and hope C++ developers in the <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> community will find it useful! Feedback is appreciated, and should be directed to <a href="#" onclick="location.href='mai'+'lto:'+'Lyn'+'to'+'n.A'+'pp'+'el@'+'cc'+'fe.'+'ac'+'.uk'; return false;">Lynto<span style="display: none;">.nosp@m.</span>n.Ap<span style="display: none;">.nosp@m.</span>pel@c<span style="display: none;">.nosp@m.</span>cfe.<span style="display: none;">.nosp@m.</span>ac.uk</a>.</p>
|
|
<h2>Installation</h2>
|
|
<p>Installing the C++ interface requires the additional flag –enable-netcdf-4 to be used during the configure stage of the installation, for example enter</p>
|
|
<p>./configure –enable-cxx-4 [plus other options]</p>
|
|
<p>To build the C++ interface guide, change to the <code>docs</code> directory of the distribution and enter</p>
|
|
<p>doxygen Doxyfile.developer</p>
|
|
<p>Alternatively, you can build the documentation using the <code>--enable-doxygen</code> flag when using <code>configure</code>, or <code>-DNCXX_ENABLE_DOXYGEN=ON</code> when using <code>cmake</code>.</p>
|
|
<p>By default, HTML documentation will be installed in cxx4/doc/html; other options may be specified according to the settings contained in the file "Doxyfile" (details of alternative settings are documented at <a href="http://www.stack.nl/~dimitri/doxygen">http://www.stack.nl/~dimitri/doxygen</a>). Note that as a prerequisite for generating the documentation, the system will need to have doxygen (<a href="http://www.stack.nl/~dimitri/doxygen">http://www.stack.nl/~dimitri/doxygen</a>) and Graphviz (<a href="http://www.graphviz.org">http://www.graphviz.org</a>)installed.</p>
|
|
<p>Examples of usage.</p>
|
|
<p>Examples codes can be found by selecting the "Examples" tab. </p>
|
|
</div></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>
|