mirror of
https://github.com/Unidata/netcdf-cxx4.git
synced 2024-12-15 08:39:54 +08:00
587 lines
29 KiB
HTML
587 lines
29 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::NcDim Class Reference</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><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="annotated.html"><span>Data Structures</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Data Fields</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('classnetCDF_1_1NcDim.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="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#friends">Friends</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">netCDF::NcDim Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class represents a <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> dimension.
|
||
|
|
<a href="classnetCDF_1_1NcDim.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include "<a class="el" href="ncDim_8h_source.html">ncDim.h</a>"</code></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:af897d4789054c231895ae3afd8c5e808"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#af897d4789054c231895ae3afd8c5e808">NcDim</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:af897d4789054c231895ae3afd8c5e808"><td class="mdescLeft"> </td><td class="mdescRight">Constructor generates a <a class="el" href="classnetCDF_1_1NcDim.html#a6d76cbe357c8b3177b8011e68e341fe8">null object</a>. <a href="#af897d4789054c231895ae3afd8c5e808">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af897d4789054c231895ae3afd8c5e808"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1a554466a5cb754dba285b0eeaed3a16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a1a554466a5cb754dba285b0eeaed3a16">NcDim</a> (const <a class="el" href="classnetCDF_1_1NcGroup.html">NcGroup</a> &grp, int dimId)</td></tr>
|
||
|
|
<tr class="memdesc:a1a554466a5cb754dba285b0eeaed3a16"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for a dimension . <a href="#a1a554466a5cb754dba285b0eeaed3a16">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a1a554466a5cb754dba285b0eeaed3a16"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2946b0ec352e8b70f87f815c14f4a164"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a2946b0ec352e8b70f87f815c14f4a164">NcDim</a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &ncDim)</td></tr>
|
||
|
|
<tr class="memdesc:a2946b0ec352e8b70f87f815c14f4a164"><td class="mdescLeft"> </td><td class="mdescRight">The copy constructor. <a href="#a2946b0ec352e8b70f87f815c14f4a164">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a2946b0ec352e8b70f87f815c14f4a164"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad2f3722611fb0783d5e9883864fa3a25"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#ad2f3722611fb0783d5e9883864fa3a25">~NcDim</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ad2f3722611fb0783d5e9883864fa3a25"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#ad2f3722611fb0783d5e9883864fa3a25">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ad2f3722611fb0783d5e9883864fa3a25"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a221ebd13646c4bb371dd74fbbe44affc"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a221ebd13646c4bb371dd74fbbe44affc">getId</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a221ebd13646c4bb371dd74fbbe44affc"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> Id of this dimension. <a href="#a221ebd13646c4bb371dd74fbbe44affc">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a221ebd13646c4bb371dd74fbbe44affc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a93a5452f4504146ae7099ac3f2eddd33"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a93a5452f4504146ae7099ac3f2eddd33">getName</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a93a5452f4504146ae7099ac3f2eddd33"><td class="mdescLeft"> </td><td class="mdescRight">The name of this dimension. <a href="#a93a5452f4504146ae7099ac3f2eddd33">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a93a5452f4504146ae7099ac3f2eddd33"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a77412cc7b571aaf54be08de663eb9a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnetCDF_1_1NcGroup.html">NcGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a77412cc7b571aaf54be08de663eb9a75">getParentGroup</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a77412cc7b571aaf54be08de663eb9a75"><td class="mdescLeft"> </td><td class="mdescRight">Gets a <a class="el" href="classnetCDF_1_1NcGroup.html" title="Class represents a netCDF group. ">NcGroup</a> object of the parent group. <a href="#a77412cc7b571aaf54be08de663eb9a75">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a77412cc7b571aaf54be08de663eb9a75"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a378d9f8c1849d4fc2a5bb8150ca5c856"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a378d9f8c1849d4fc2a5bb8150ca5c856">getSize</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a378d9f8c1849d4fc2a5bb8150ca5c856"><td class="mdescLeft"> </td><td class="mdescRight">The size of the dimension; for unlimited, this is the number of records written so far. <a href="#a378d9f8c1849d4fc2a5bb8150ca5c856">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a378d9f8c1849d4fc2a5bb8150ca5c856"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6d76cbe357c8b3177b8011e68e341fe8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a6d76cbe357c8b3177b8011e68e341fe8">isNull</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a6d76cbe357c8b3177b8011e68e341fe8"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this object is null (i.e. <a href="#a6d76cbe357c8b3177b8011e68e341fe8">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a6d76cbe357c8b3177b8011e68e341fe8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9f7497a9d31995056d51f3389fc04023"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a9f7497a9d31995056d51f3389fc04023">isUnlimited</a> () const </td></tr>
|
||
|
|
<tr class="memdesc:a9f7497a9d31995056d51f3389fc04023"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this is an unlimited dimension. <a href="#a9f7497a9d31995056d51f3389fc04023">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a9f7497a9d31995056d51f3389fc04023"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a19093d3f24adc06c11e57fd7c21b9925"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a19093d3f24adc06c11e57fd7c21b9925">operator!=</a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &rhs) const </td></tr>
|
||
|
|
<tr class="memdesc:a19093d3f24adc06c11e57fd7c21b9925"><td class="mdescLeft"> </td><td class="mdescRight">!= operator <a href="#a19093d3f24adc06c11e57fd7c21b9925">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a19093d3f24adc06c11e57fd7c21b9925"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a91b0ad217633643f05bbef3bb7dd43be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a91b0ad217633643f05bbef3bb7dd43be">operator=</a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &)</td></tr>
|
||
|
|
<tr class="memdesc:a91b0ad217633643f05bbef3bb7dd43be"><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <a href="#a91b0ad217633643f05bbef3bb7dd43be">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a91b0ad217633643f05bbef3bb7dd43be"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a74b6097f1faba62db140ef90d93baedd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a74b6097f1faba62db140ef90d93baedd">operator==</a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &rhs) const </td></tr>
|
||
|
|
<tr class="memdesc:a74b6097f1faba62db140ef90d93baedd"><td class="mdescLeft"> </td><td class="mdescRight">equivalence operator <a href="#a74b6097f1faba62db140ef90d93baedd">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a74b6097f1faba62db140ef90d93baedd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad145fa3229682fab51468b3258572995"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#ad145fa3229682fab51468b3258572995">rename</a> (const std::string &newName)</td></tr>
|
||
|
|
<tr class="memdesc:ad145fa3229682fab51468b3258572995"><td class="mdescLeft"> </td><td class="mdescRight">renames the dimension <a href="#ad145fa3229682fab51468b3258572995">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ad145fa3229682fab51468b3258572995"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
||
|
|
Friends</h2></td></tr>
|
||
|
|
<tr class="memitem:a21479a316ff9af87d6d44a36d03775ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a21479a316ff9af87d6d44a36d03775ed">operator<</a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &lhs, const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &rhs)</td></tr>
|
||
|
|
<tr class="memdesc:a21479a316ff9af87d6d44a36d03775ed"><td class="mdescLeft"> </td><td class="mdescRight">comparator operator <a href="#a21479a316ff9af87d6d44a36d03775ed">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a21479a316ff9af87d6d44a36d03775ed"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2f4b1476f86be1a97221b31008f3bb64"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcDim.html#a2f4b1476f86be1a97221b31008f3bb64">operator></a> (const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &lhs, const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> &rhs)</td></tr>
|
||
|
|
<tr class="memdesc:a2f4b1476f86be1a97221b31008f3bb64"><td class="mdescLeft"> </td><td class="mdescRight">comparator operator <a href="#a2f4b1476f86be1a97221b31008f3bb64">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a2f4b1476f86be1a97221b31008f3bb64"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class represents a <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> dimension. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8h_source.html#l00013">13</a> of file <a class="el" href="ncDim_8h_source.html">ncDim.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="ad2f3722611fb0783d5e9883864fa3a25"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">netCDF::NcDim::~NcDim </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>destructor </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8h_source.html#l00018">18</a> of file <a class="el" href="ncDim_8h_source.html">ncDim.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="af897d4789054c231895ae3afd8c5e808"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">NcDim::NcDim </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Constructor generates a <a class="el" href="classnetCDF_1_1NcDim.html#a6d76cbe357c8b3177b8011e68e341fe8">null object</a>. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00064">64</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a1a554466a5cb754dba285b0eeaed3a16"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">NcDim::NcDim </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcGroup.html">NcGroup</a> & </td>
|
||
|
|
<td class="paramname"><em>grp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>dimId</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Constructor for a dimension . </p>
|
||
|
|
<p>The dimension must already exist in the <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> file. New <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> variables can be added using NcGroup::addNcDim(); </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">grp</td><td>Parent <a class="el" href="classnetCDF_1_1NcGroup.html" title="Class represents a netCDF group. ">NcGroup</a> object. </td></tr>
|
||
|
|
<tr><td class="paramname">dimId</td><td>Id of the <a class="el" href="classnetCDF_1_1NcDim.html" title="Class represents a netCDF dimension. ">NcDim</a> object. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00069">69</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a2946b0ec352e8b70f87f815c14f4a164"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">NcDim::NcDim </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>ncDim</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The copy constructor. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00035">35</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a221ebd13646c4bb371dd74fbbe44affc"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const int netCDF::NcDim::getId </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> Id of this dimension. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8h_source.html#l00047">47</a> of file <a class="el" href="ncDim_8h_source.html">ncDim.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a93a5452f4504146ae7099ac3f2eddd33"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const string NcDim::getName </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The name of this dimension. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00106">106</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a77412cc7b571aaf54be08de663eb9a75"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classnetCDF_1_1NcGroup.html">NcGroup</a> NcDim::getParentGroup </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a <a class="el" href="classnetCDF_1_1NcGroup.html" title="Class represents a netCDF group. ">NcGroup</a> object of the parent group. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00059">59</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a378d9f8c1849d4fc2a5bb8150ca5c856"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t NcDim::getSize </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The size of the dimension; for unlimited, this is the number of records written so far. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00077">77</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6d76cbe357c8b3177b8011e68e341fe8"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool netCDF::NcDim::isNull </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns true if this object is null (i.e. </p>
|
||
|
|
<p>it has no contents); otherwise returns false. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8h_source.html#l00062">62</a> of file <a class="el" href="ncDim_8h_source.html">ncDim.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9f7497a9d31995056d51f3389fc04023"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NcDim::isUnlimited </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns true if this is an unlimited dimension. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00086">86</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a19093d3f24adc06c11e57fd7c21b9925"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NcDim::operator!= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>rhs</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>!= operator </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00052">52</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a91b0ad217633643f05bbef3bb7dd43be"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & NcDim::operator= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>rhs</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>assignment operator </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00026">26</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a74b6097f1faba62db140ef90d93baedd"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NcDim::operator== </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>rhs</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>equivalence operator </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00043">43</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ad145fa3229682fab51468b3258572995"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void NcDim::rename </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </td>
|
||
|
|
<td class="paramname"><em>newName</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>renames the dimension </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00114">114</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a21479a316ff9af87d6d44a36d03775ed"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool operator< </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>lhs</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>rhs</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>comparator operator </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00011">11</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a2f4b1476f86be1a97221b31008f3bb64"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool operator> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>lhs</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcDim.html">NcDim</a> & </td>
|
||
|
|
<td class="paramname"><em>rhs</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>comparator operator </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="ncDim_8cpp_source.html#l00017">17</a> of file <a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li><a class="el" href="ncDim_8h_source.html">ncDim.h</a></li>
|
||
|
|
<li><a class="el" href="ncDim_8cpp_source.html">ncDim.cpp</a></li>
|
||
|
|
</ul>
|
||
|
|
</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>
|