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

712 lines
38 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::NcUint64 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++
&#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><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&#160;Structures</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;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_1NcUint64.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">netCDF::NcUint64 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> atomic Uint64 type.
<a href="classnetCDF_1_1NcUint64.html#details">More...</a></p>
<p><code>#include &quot;<a class="el" href="ncUint64_8h_source.html">ncUint64.h</a>&quot;</code></p>
<div class="dynheader">
Inheritance diagram for netCDF::NcUint64:</div>
<div class="dyncontent">
<div class="center"><img src="classnetCDF_1_1NcUint64__inherit__graph.png" border="0" usemap="#netCDF_1_1NcUint64_inherit__map" alt="Inheritance graph"/></div>
<map name="netCDF_1_1NcUint64_inherit__map" id="netCDF_1_1NcUint64_inherit__map">
<area shape="rect" id="node2" href="classnetCDF_1_1NcType.html" title="Base class inherited by NcOpaque, NcVlen, NcCompound and NcEnum classes. " alt="" coords="9,5,132,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for netCDF::NcUint64:</div>
<div class="dyncontent">
<div class="center"><img src="classnetCDF_1_1NcUint64__coll__graph.png" border="0" usemap="#netCDF_1_1NcUint64_coll__map" alt="Collaboration graph"/></div>
<map name="netCDF_1_1NcUint64_coll__map" id="netCDF_1_1NcUint64_coll__map">
<area shape="rect" id="node2" href="classnetCDF_1_1NcType.html" title="Base class inherited by NcOpaque, NcVlen, NcCompound and NcEnum classes. " alt="" coords="9,5,132,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8b3e86d98c97b11782734a60b724ae7f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7f">ncType</a> { <br />
&#160;&#160;<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa39f3556cdbbffedb85cd6930872442c1">nc_BYTE</a> = NC_BYTE,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa2e28eceba55e637bf87e5958a241360b">nc_CHAR</a> = NC_CHAR,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa2f7dedd55207fa3b2f908d7915634f17">nc_SHORT</a> = NC_SHORT,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa7bb5854095d36acc4b03d07df2eefcfe">nc_INT</a> = NC_INT,
<br />
&#160;&#160;<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fad5afb93c20ef69352cfa2de4b21074a4">nc_FLOAT</a> = NC_FLOAT,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa00155273652a5859389fdae37be7b7d8">nc_DOUBLE</a> = NC_DOUBLE,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa05e76082d439c3e50568ba1904f3da15">nc_UBYTE</a> = NC_UBYTE,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7facb8daf4158d90b27ee42ba181414e770">nc_USHORT</a> = NC_USHORT,
<br />
&#160;&#160;<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa78bc8c5f1df86462628a98e2598bb409">nc_UINT</a> = NC_UINT,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fac751b4d728af0254aeea65babc0cc2c3">nc_INT64</a> = NC_INT64,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa4284522760b6f04cd7315cc27632f33b">nc_UINT64</a> = NC_UINT64,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7faba0a598b99f18ed9a2f1fd6f0fa3486c">nc_STRING</a> = NC_STRING,
<br />
&#160;&#160;<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa6487471ed92d0ffd8f4f491fdd546973">nc_VLEN</a> = NC_VLEN,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa10e98cfb098bc69f36afdbdda027ec47">nc_OPAQUE</a> = NC_OPAQUE,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fa99a57ebc9a9aab2582ed59e56ec14cb6">nc_ENUM</a> = NC_ENUM,
<a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7fad84521f74d1847bfe1f1c56250237870">nc_COMPOUND</a> = NC_COMPOUND
<br />
}<tr class="memdesc:a8b3e86d98c97b11782734a60b724ae7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> types that can be represented. <a href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a8b3e86d98c97b11782734a60b724ae7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a0189f86db31364394bc838251c6abd0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcUint64.html#a0189f86db31364394bc838251c6abd0b">NcUint64</a> ()</td></tr>
<tr class="memdesc:a0189f86db31364394bc838251c6abd0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a0189f86db31364394bc838251c6abd0b">More...</a><br /></td></tr>
<tr class="separator:a0189f86db31364394bc838251c6abd0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af02c7d2825a953cf6d0d6f7b27019d0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcUint64.html#af02c7d2825a953cf6d0d6f7b27019d0c">~NcUint64</a> ()</td></tr>
<tr class="memdesc:af02c7d2825a953cf6d0d6f7b27019d0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="#af02c7d2825a953cf6d0d6f7b27019d0c">More...</a><br /></td></tr>
<tr class="separator:af02c7d2825a953cf6d0d6f7b27019d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ee30763d993b6e156b0acb5cbb1aa01"><td class="memItemLeft" align="right" valign="top">nc_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a9ee30763d993b6e156b0acb5cbb1aa01">getId</a> () const </td></tr>
<tr class="memdesc:a9ee30763d993b6e156b0acb5cbb1aa01"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> Id of this type. <a href="#a9ee30763d993b6e156b0acb5cbb1aa01">More...</a><br /></td></tr>
<tr class="separator:a9ee30763d993b6e156b0acb5cbb1aa01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c0c610370987eb021830525c128334"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a45c0c610370987eb021830525c128334">getName</a> () const </td></tr>
<tr class="memdesc:a45c0c610370987eb021830525c128334"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of this type. <a href="#a45c0c610370987eb021830525c128334">More...</a><br /></td></tr>
<tr class="separator:a45c0c610370987eb021830525c128334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad99c136ed65fce6411f5b178d35bc913"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnetCDF_1_1NcGroup.html">netCDF::NcGroup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#ad99c136ed65fce6411f5b178d35bc913">getParentGroup</a> () const </td></tr>
<tr class="memdesc:ad99c136ed65fce6411f5b178d35bc913"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets parent group. <a href="#ad99c136ed65fce6411f5b178d35bc913">More...</a><br /></td></tr>
<tr class="separator:ad99c136ed65fce6411f5b178d35bc913"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a0c0f30237e0051d18a64bbff05da6b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a2a0c0f30237e0051d18a64bbff05da6b">getSize</a> () const </td></tr>
<tr class="memdesc:a2a0c0f30237e0051d18a64bbff05da6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size in bytes. <a href="#a2a0c0f30237e0051d18a64bbff05da6b">More...</a><br /></td></tr>
<tr class="separator:a2a0c0f30237e0051d18a64bbff05da6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a1184dd1b3bb493c621f1ae100c4bab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7f">ncType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a7a1184dd1b3bb493c621f1ae100c4bab">getTypeClass</a> () const </td></tr>
<tr class="memdesc:a7a1184dd1b3bb493c621f1ae100c4bab"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type class returned as enumeration type. <a href="#a7a1184dd1b3bb493c621f1ae100c4bab">More...</a><br /></td></tr>
<tr class="separator:a7a1184dd1b3bb493c621f1ae100c4bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9739ed229df4904e2d669cabc427576d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a9739ed229df4904e2d669cabc427576d">getTypeClassName</a> () const </td></tr>
<tr class="memdesc:a9739ed229df4904e2d669cabc427576d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string containing the name of the enumerated type. <a href="#a9739ed229df4904e2d669cabc427576d">More...</a><br /></td></tr>
<tr class="separator:a9739ed229df4904e2d669cabc427576d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85215ef28dab2d36c23257436ca00300"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a85215ef28dab2d36c23257436ca00300">isNull</a> () const </td></tr>
<tr class="memdesc:a85215ef28dab2d36c23257436ca00300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this object is null (i.e. <a href="#a85215ef28dab2d36c23257436ca00300">More...</a><br /></td></tr>
<tr class="separator:a85215ef28dab2d36c23257436ca00300"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86599bdccb03a7b8337e4c8dffa9daeb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a86599bdccb03a7b8337e4c8dffa9daeb">operator!=</a> (const <a class="el" href="classnetCDF_1_1NcType.html">NcType</a> &amp;) const </td></tr>
<tr class="memdesc:a86599bdccb03a7b8337e4c8dffa9daeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">!= operator <a href="#a86599bdccb03a7b8337e4c8dffa9daeb">More...</a><br /></td></tr>
<tr class="separator:a86599bdccb03a7b8337e4c8dffa9daeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633afb97af0ae538f7c24438d822a2f7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcUint64.html#a633afb97af0ae538f7c24438d822a2f7">operator==</a> (const <a class="el" href="classnetCDF_1_1NcUint64.html">NcUint64</a> &amp;rhs)</td></tr>
<tr class="memdesc:a633afb97af0ae538f7c24438d822a2f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">equivalence operator <a href="#a633afb97af0ae538f7c24438d822a2f7">More...</a><br /></td></tr>
<tr class="separator:a633afb97af0ae538f7c24438d822a2f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e38f465add7c577163f19c1326e23bc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a6e38f465add7c577163f19c1326e23bc">operator==</a> (const <a class="el" href="classnetCDF_1_1NcType.html">NcType</a> &amp;) const </td></tr>
<tr class="memdesc:a6e38f465add7c577163f19c1326e23bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">equivalence operator <a href="#a6e38f465add7c577163f19c1326e23bc">More...</a><br /></td></tr>
<tr class="separator:a6e38f465add7c577163f19c1326e23bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:afaf95bc47d924dace3e3f65405426b07"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#afaf95bc47d924dace3e3f65405426b07">g_fileId</a></td></tr>
<tr class="memdesc:afaf95bc47d924dace3e3f65405426b07"><td class="mdescLeft">&#160;</td><td class="mdescRight">An ncid associated with a particular open file (returned from nc_open). <a href="#afaf95bc47d924dace3e3f65405426b07">More...</a><br /></td></tr>
<tr class="separator:afaf95bc47d924dace3e3f65405426b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0117a94cc1a58223c3ba634dd2cea6f7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a0117a94cc1a58223c3ba634dd2cea6f7">groupId</a></td></tr>
<tr class="memdesc:a0117a94cc1a58223c3ba634dd2cea6f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">the group Id <a href="#a0117a94cc1a58223c3ba634dd2cea6f7">More...</a><br /></td></tr>
<tr class="separator:a0117a94cc1a58223c3ba634dd2cea6f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f7b930e614ae371618cf9759fc0426b"><td class="memItemLeft" align="right" valign="top">nc_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnetCDF_1_1NcType.html#a5f7b930e614ae371618cf9759fc0426b">myId</a></td></tr>
<tr class="memdesc:a5f7b930e614ae371618cf9759fc0426b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the type Id <a href="#a5f7b930e614ae371618cf9759fc0426b">More...</a><br /></td></tr>
<tr class="separator:a5f7b930e614ae371618cf9759fc0426b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86e78edb9abf5dbd4c69a42d16c5c3eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86e78edb9abf5dbd4c69a42d16c5c3eb"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>nullObject</b></td></tr>
<tr class="separator:a86e78edb9abf5dbd4c69a42d16c5c3eb"><td class="memSeparator" colspan="2">&#160;</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> atomic Uint64 type. </p>
<p>Definition at line <a class="el" href="ncUint64_8h_source.html#l00010">10</a> of file <a class="el" href="ncUint64_8h_source.html">ncUint64.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7f">netCDF::NcType::ncType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>List of <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> types that can be represented. </p>
<p>The enumeration list contains the complete set of <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> variable types. In addition, the type NC_TYPE is included. This enables the user to instantiate a <a class="el" href="namespacenetCDF.html" title="C++ API for netCDF4. ">netCDF</a> type object without explcitly needing to know it precise type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa39f3556cdbbffedb85cd6930872442c1"></a>nc_BYTE&#160;</td><td class="fielddoc">
<p>signed 1 byte integer </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa2e28eceba55e637bf87e5958a241360b"></a>nc_CHAR&#160;</td><td class="fielddoc">
<p>ISO/ASCII character. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa2f7dedd55207fa3b2f908d7915634f17"></a>nc_SHORT&#160;</td><td class="fielddoc">
<p>signed 2 byte integer </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa7bb5854095d36acc4b03d07df2eefcfe"></a>nc_INT&#160;</td><td class="fielddoc">
<p>signed 4 byte integer </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fad5afb93c20ef69352cfa2de4b21074a4"></a>nc_FLOAT&#160;</td><td class="fielddoc">
<p>single precision floating point number </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa00155273652a5859389fdae37be7b7d8"></a>nc_DOUBLE&#160;</td><td class="fielddoc">
<p>double precision floating point number </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa05e76082d439c3e50568ba1904f3da15"></a>nc_UBYTE&#160;</td><td class="fielddoc">
<p>unsigned 1 byte int </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7facb8daf4158d90b27ee42ba181414e770"></a>nc_USHORT&#160;</td><td class="fielddoc">
<p>unsigned 2-byte int </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa78bc8c5f1df86462628a98e2598bb409"></a>nc_UINT&#160;</td><td class="fielddoc">
<p>unsigned 4-byte int </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fac751b4d728af0254aeea65babc0cc2c3"></a>nc_INT64&#160;</td><td class="fielddoc">
<p>signed 8-byte int </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa4284522760b6f04cd7315cc27632f33b"></a>nc_UINT64&#160;</td><td class="fielddoc">
<p>unsigned 8-byte int </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7faba0a598b99f18ed9a2f1fd6f0fa3486c"></a>nc_STRING&#160;</td><td class="fielddoc">
<p>string </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa6487471ed92d0ffd8f4f491fdd546973"></a>nc_VLEN&#160;</td><td class="fielddoc">
<p>"NcVlen type" </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa10e98cfb098bc69f36afdbdda027ec47"></a>nc_OPAQUE&#160;</td><td class="fielddoc">
<p>"NcOpaque type" </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fa99a57ebc9a9aab2582ed59e56ec14cb6"></a>nc_ENUM&#160;</td><td class="fielddoc">
<p>"NcEnum type" </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a8b3e86d98c97b11782734a60b724ae7fad84521f74d1847bfe1f1c56250237870"></a>nc_COMPOUND&#160;</td><td class="fielddoc">
<p>"NcCompound type" </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ncType_8h_source.html#l00025">25</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af02c7d2825a953cf6d0d6f7b27019d0c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NcUint64::~NcUint64 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
<p>Definition at line <a class="el" href="ncUint64_8cpp_source.html#l00014">14</a> of file <a class="el" href="ncUint64_8cpp_source.html">ncUint64.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0189f86db31364394bc838251c6abd0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NcUint64::NcUint64 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="ncUint64_8cpp_source.html#l00011">11</a> of file <a class="el" href="ncUint64_8cpp_source.html">ncUint64.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9ee30763d993b6e156b0acb5cbb1aa01"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nc_type netCDF::NcType::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 class="mlabel">inherited</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 type. </p>
<p>Definition at line <a class="el" href="ncType_8h_source.html#l00088">88</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<a class="anchor" id="a45c0c610370987eb021830525c128334"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string NcType::getName </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of this type. </p>
<p>For atomic types, the CDL type names are returned. These are as follows:</p><ul>
<li><a class="el" href="classnetCDF_1_1NcByte.html" title="Class represents a netCDF atomic Byte type. ">NcByte</a> String returned is "byte".</li>
<li><a class="el" href="classnetCDF_1_1NcUbyte.html" title="Class represents a netCDF atomic Ubyte type. ">NcUbyte</a> String returned is "ubyte".</li>
<li><a class="el" href="classnetCDF_1_1NcChar.html" title="Class represents a netCDF atomic Char type. ">NcChar</a> String returned is "char".</li>
<li><a class="el" href="classnetCDF_1_1NcShort.html" title="Class represents a netCDF atomic Short type. ">NcShort</a> String returned is "short".</li>
<li><a class="el" href="classnetCDF_1_1NcUshort.html" title="Class represents a netCDF atomic Ushort type. ">NcUshort</a> String returned is "ushort".</li>
<li><a class="el" href="classnetCDF_1_1NcInt.html" title="Class represents a netCDF atomic Int type. ">NcInt</a> String returned is "int".</li>
<li><a class="el" href="classnetCDF_1_1NcUint.html" title="Class represents a netCDF atomic Uint type. ">NcUint</a> String returned is "uint".</li>
<li><a class="el" href="classnetCDF_1_1NcInt64.html" title="Class represents a netCDF atomic Int64 type. ">NcInt64</a> String returned is "int64".</li>
<li><a class="el" href="classnetCDF_1_1NcUint64.html" title="Class represents a netCDF atomic Uint64 type. ">NcUint64</a> String returned is "uint64".</li>
<li><a class="el" href="classnetCDF_1_1NcFloat.html" title="Class represents a netCDF atomic Float type. ">NcFloat</a> String returned is "float".</li>
<li><a class="el" href="classnetCDF_1_1NcDouble.html" title="Class represents a netCDF atomic Double type. ">NcDouble</a> String returned is "double".</li>
<li><a class="el" href="classnetCDF_1_1NcString.html" title="Class represents a netCDF atomic String type. ">NcString</a> String returned is "string". </li>
</ul>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00094">94</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad99c136ed65fce6411f5b178d35bc913"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnetCDF_1_1NcGroup.html">NcGroup</a> NcType::getParentGroup </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets parent group. </p>
<p>For an atomic type, returns a Null object. </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00089">89</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2a0c0f30237e0051d18a64bbff05da6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t NcType::getSize </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The size in bytes. </p>
<p>This function will work on any type, including atomic and any user defined type, whether compound, opaque, enumeration, or variable length array. </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00108">108</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7a1184dd1b3bb493c621f1ae100c4bab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnetCDF_1_1NcType.html#a8b3e86d98c97b11782734a60b724ae7f">NcType::ncType</a> NcType::getTypeClass </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The type class returned as enumeration type. </p>
<p>Valid for all types, whether atomic or user-defined. User-defined types are returned as one of the following enumeration types: nc_VLEN, nc_OPAQUE, nc_ENUM, or nc_COMPOUND. </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00116">116</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9739ed229df4904e2d669cabc427576d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string NcType::getTypeClassName </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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string containing the name of the enumerated type. </p>
<p>(ie one of the following strings: "nc_BYTE", "nc_CHAR", "nc_SHORT", "nc_INT", "nc_FLOAT", "nc_DOUBLE", "nc_UBYTE", "nc_USHORT", "nc_UINT", "nc_INT64", "nc_UINT64", "nc_STRING", "nc_VLEN", "nc_OPAQUE", "nc_ENUM", "nc_COMPOUND" </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00144">144</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a85215ef28dab2d36c23257436ca00300"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool netCDF::NcType::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 class="mlabel">inherited</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="ncType_8h_source.html#l00133">133</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<a class="anchor" id="a86599bdccb03a7b8337e4c8dffa9daeb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NcType::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcType.html">NcType</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>!= operator </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00083">83</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a633afb97af0ae538f7c24438d822a2f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NcUint64::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcUint64.html">NcUint64</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>equivalence operator </p>
<p>Definition at line <a class="el" href="ncUint64_8cpp_source.html#l00019">19</a> of file <a class="el" href="ncUint64_8cpp_source.html">ncUint64.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6e38f465add7c577163f19c1326e23bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NcType::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classnetCDF_1_1NcType.html">NcType</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>equivalence operator </p>
<p>Definition at line <a class="el" href="ncType_8cpp_source.html#l00074">74</a> of file <a class="el" href="ncType_8cpp_source.html">ncType.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="afaf95bc47d924dace3e3f65405426b07"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int netCDF::NcType::g_fileId</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An ncid associated with a particular open file (returned from nc_open). </p>
<p>This is required by many of the functions ncType uses, such as nc_inq_type </p>
<p>Definition at line <a class="el" href="ncType_8h_source.html#l00158">158</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0117a94cc1a58223c3ba634dd2cea6f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int netCDF::NcType::groupId</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the group Id </p>
<p>Definition at line <a class="el" href="ncType_8h_source.html#l00152">152</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5f7b930e614ae371618cf9759fc0426b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nc_type netCDF::NcType::myId</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the type Id </p>
<p>Definition at line <a class="el" href="ncType_8h_source.html#l00149">149</a> of file <a class="el" href="ncType_8h_source.html">ncType.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ncUint64_8h_source.html">ncUint64.h</a></li>
<li><a class="el" href="ncUint64_8cpp_source.html">ncUint64.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>