Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1TimestampBase.html
blob: 2f823b7aaead5a0fa02b4c7f16f9a878fa3de9fe [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::TimestampBase 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="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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1TimestampBase.html">TimestampBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1TimestampBase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::TimestampBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__type-primitive.html">Primitive Types</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>A base class for any timestamp time (irrespective of unit or timezone).
<a href="classiceberg_1_1TimestampBase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="type_8h_source.html">type.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::TimestampBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1TimestampBase.png" usemap="#iceberg::TimestampBase_map" alt=""/>
<map id="iceberg::TimestampBase_map" name="iceberg::TimestampBase_map">
<area href="classiceberg_1_1PrimitiveType.html" title="A data type that does not have child fields." alt="iceberg::PrimitiveType" shape="rect" coords="85,112,245,136"/>
<area href="classiceberg_1_1Type.html" title="Interface for a data type for a field." alt="iceberg::Type" shape="rect" coords="85,56,245,80"/>
<area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="85,0,245,24"/>
<area href="classiceberg_1_1TimestampType.html" title="A data type representing a timestamp in microseconds without reference to a timezone." alt="iceberg::TimestampType" shape="rect" coords="0,224,160,248"/>
<area href="classiceberg_1_1TimestampTzType.html" title="A data type representing a timestamp as microseconds since the epoch in UTC. A time zone or offset is..." alt="iceberg::TimestampTzType" shape="rect" coords="170,224,330,248"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab062d6f49e7f378a81d20601d41e0994" id="r_ab062d6f49e7f378a81d20601d41e0994"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TimestampBase.html#ab062d6f49e7f378a81d20601d41e0994">is_zoned</a> () const =0</td></tr>
<tr class="memdesc:ab062d6f49e7f378a81d20601d41e0994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this type zoned or naive? <br /></td></tr>
<tr class="separator:ab062d6f49e7f378a81d20601d41e0994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c5676ebebea0df936a4ada5b7294c3" id="r_ac7c5676ebebea0df936a4ada5b7294c3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="type__fwd_8h.html#a4082287dfe7a2b960a8c638d5f0cf39a">TimeUnit</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TimestampBase.html#ac7c5676ebebea0df936a4ada5b7294c3">time_unit</a> () const =0</td></tr>
<tr class="memdesc:ac7c5676ebebea0df936a4ada5b7294c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time resolution. <br /></td></tr>
<tr class="separator:ac7c5676ebebea0df936a4ada5b7294c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1PrimitiveType"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1PrimitiveType')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1PrimitiveType.html">iceberg::PrimitiveType</a></td></tr>
<tr class="memitem:a1cc061d5de221d54396f571681bf090a inherit pub_methods_classiceberg_1_1PrimitiveType" id="r_a1cc061d5de221d54396f571681bf090a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PrimitiveType.html#a1cc061d5de221d54396f571681bf090a">is_primitive</a> () const override</td></tr>
<tr class="memdesc:a1cc061d5de221d54396f571681bf090a inherit pub_methods_classiceberg_1_1PrimitiveType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this a primitive type (may not have child fields)? <br /></td></tr>
<tr class="separator:a1cc061d5de221d54396f571681bf090a inherit pub_methods_classiceberg_1_1PrimitiveType"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8b76f12af1e8e9861b2a9fbab776f7c inherit pub_methods_classiceberg_1_1PrimitiveType" id="r_ae8b76f12af1e8e9861b2a9fbab776f7c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PrimitiveType.html#ae8b76f12af1e8e9861b2a9fbab776f7c">is_nested</a> () const override</td></tr>
<tr class="memdesc:ae8b76f12af1e8e9861b2a9fbab776f7c inherit pub_methods_classiceberg_1_1PrimitiveType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this a nested type (may have child fields)? <br /></td></tr>
<tr class="separator:ae8b76f12af1e8e9861b2a9fbab776f7c inherit pub_methods_classiceberg_1_1PrimitiveType"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Type')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Type.html">iceberg::Type</a></td></tr>
<tr class="memitem:a492b2d8720b13673ad0955bd5fe3bf27 inherit pub_methods_classiceberg_1_1Type" id="r_a492b2d8720b13673ad0955bd5fe3bf27"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="type__fwd_8h.html#afd7801064886b233ca23eadf5ba2c1b8">TypeId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Type.html#a492b2d8720b13673ad0955bd5fe3bf27">type_id</a> () const =0</td></tr>
<tr class="memdesc:a492b2d8720b13673ad0955bd5fe3bf27 inherit pub_methods_classiceberg_1_1Type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type ID. <br /></td></tr>
<tr class="separator:a492b2d8720b13673ad0955bd5fe3bf27 inherit pub_methods_classiceberg_1_1Type"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1util_1_1Formattable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1util_1_1Formattable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a></td></tr>
<tr class="memitem:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable" id="r_a79618aca5b3bf63610d9c87ac5ae0386"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">ToString</a> () const =0</td></tr>
<tr class="memdesc:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr>
<tr class="separator:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classiceberg_1_1Type"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classiceberg_1_1Type')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classiceberg_1_1Type.html">iceberg::Type</a></td></tr>
<tr class="memitem:a9eb55b3cb339747a0b8081c5c5d73103 inherit pro_methods_classiceberg_1_1Type" id="r_a9eb55b3cb339747a0b8081c5c5d73103"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Type.html#a9eb55b3cb339747a0b8081c5c5d73103">Equals</a> (const <a class="el" href="classiceberg_1_1Type.html">Type</a> &amp;other) const =0</td></tr>
<tr class="memdesc:a9eb55b3cb339747a0b8081c5c5d73103 inherit pro_methods_classiceberg_1_1Type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two types for equality. <br /></td></tr>
<tr class="separator:a9eb55b3cb339747a0b8081c5c5d73103 inherit pro_methods_classiceberg_1_1Type"><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>A base class for any timestamp time (irrespective of unit or timezone). </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab062d6f49e7f378a81d20601d41e0994" name="ab062d6f49e7f378a81d20601d41e0994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab062d6f49e7f378a81d20601d41e0994">&#9670;&#160;</a></span>is_zoned()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool iceberg::TimestampBase::is_zoned </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is this type zoned or naive? </p>
<p>Implemented in <a class="el" href="classiceberg_1_1TimestampType.html#a9b56a903dc4a8f2db5d78bc6ee441251">iceberg::TimestampType</a>, and <a class="el" href="classiceberg_1_1TimestampTzType.html#a01bdada6f348e63943ffcabe274344ce">iceberg::TimestampTzType</a>.</p>
</div>
</div>
<a id="ac7c5676ebebea0df936a4ada5b7294c3" name="ac7c5676ebebea0df936a4ada5b7294c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c5676ebebea0df936a4ada5b7294c3">&#9670;&#160;</a></span>time_unit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="type__fwd_8h.html#a4082287dfe7a2b960a8c638d5f0cf39a">TimeUnit</a> iceberg::TimestampBase::time_unit </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The time resolution. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1TimestampType.html#a9eba8144a531fa80f8179691eeb1042d">iceberg::TimestampType</a>, and <a class="el" href="classiceberg_1_1TimestampTzType.html#a66d115a7b1202ae86aad115be2f1c945">iceberg::TimestampTzType</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="type_8h_source.html">type.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>