blob: 7e607c06b4e1a7cd9ac9ee6150392ada6dbf0d43 [file]
<!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::GeospatialBound 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1GeospatialBound-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::GeospatialBound Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A point used as a lower or upper geospatial column bound.
<a href="classiceberg_1_1GeospatialBound.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="geospatial_8h_source.html">geospatial.h</a>&gt;</code></p>
<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:a23964d7f0b70e89626e27d0f63aa500f" id="r_a23964d7f0b70e89626e27d0f63aa500f"><td class="memItemLeft" align="right" valign="top"><a id="a23964d7f0b70e89626e27d0f63aa500f" name="a23964d7f0b70e89626e27d0f63aa500f"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>x</b> () const</td></tr>
<tr class="memdesc:a23964d7f0b70e89626e27d0f63aa500f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the X coordinate. <br /></td></tr>
<tr class="separator:a23964d7f0b70e89626e27d0f63aa500f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17c7796d3f77afc3479ca7017464528c" id="r_a17c7796d3f77afc3479ca7017464528c"><td class="memItemLeft" align="right" valign="top"><a id="a17c7796d3f77afc3479ca7017464528c" name="a17c7796d3f77afc3479ca7017464528c"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>y</b> () const</td></tr>
<tr class="memdesc:a17c7796d3f77afc3479ca7017464528c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the Y coordinate. <br /></td></tr>
<tr class="separator:a17c7796d3f77afc3479ca7017464528c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5919e245b92d705a7d8a82664fe6b3e6" id="r_a5919e245b92d705a7d8a82664fe6b3e6"><td class="memItemLeft" align="right" valign="top"><a id="a5919e245b92d705a7d8a82664fe6b3e6" name="a5919e245b92d705a7d8a82664fe6b3e6"></a>
const std::optional&lt; double &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>z</b> () const</td></tr>
<tr class="memdesc:a5919e245b92d705a7d8a82664fe6b3e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the optional Z coordinate. <br /></td></tr>
<tr class="separator:a5919e245b92d705a7d8a82664fe6b3e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae426ca3c35292df9281a2165578f10c3" id="r_ae426ca3c35292df9281a2165578f10c3"><td class="memItemLeft" align="right" valign="top"><a id="ae426ca3c35292df9281a2165578f10c3" name="ae426ca3c35292df9281a2165578f10c3"></a>
const std::optional&lt; double &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m</b> () const</td></tr>
<tr class="memdesc:ae426ca3c35292df9281a2165578f10c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the optional M coordinate. <br /></td></tr>
<tr class="separator:ae426ca3c35292df9281a2165578f10c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab38fe3e901d2dc4547f7569bd2518914" id="r_ab38fe3e901d2dc4547f7569bd2518914"><td class="memItemLeft" align="right" valign="top"><a id="ab38fe3e901d2dc4547f7569bd2518914" name="ab38fe3e901d2dc4547f7569bd2518914"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Serialize</b> () const</td></tr>
<tr class="memdesc:ab38fe3e901d2dc4547f7569bd2518914"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode this bound using little-endian encoding. <br /></td></tr>
<tr class="separator:ab38fe3e901d2dc4547f7569bd2518914"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5b7b73d527ae1a89b9038305f8b04c60" id="r_a5b7b73d527ae1a89b9038305f8b04c60"><td class="memItemLeft" align="right" valign="top"><a id="a5b7b73d527ae1a89b9038305f8b04c60" name="a5b7b73d527ae1a89b9038305f8b04c60"></a>
static <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a>&#160;</td><td class="memItemRight" valign="bottom"><b>XY</b> (double <a class="el" href="classiceberg_1_1GeospatialBound.html#a23964d7f0b70e89626e27d0f63aa500f">x</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a17c7796d3f77afc3479ca7017464528c">y</a>)</td></tr>
<tr class="memdesc:a5b7b73d527ae1a89b9038305f8b04c60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a two-dimensional bound. <br /></td></tr>
<tr class="separator:a5b7b73d527ae1a89b9038305f8b04c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71659496f7f313cce12ddaa53c54d368" id="r_a71659496f7f313cce12ddaa53c54d368"><td class="memItemLeft" align="right" valign="top"><a id="a71659496f7f313cce12ddaa53c54d368" name="a71659496f7f313cce12ddaa53c54d368"></a>
static <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a>&#160;</td><td class="memItemRight" valign="bottom"><b>XYZ</b> (double <a class="el" href="classiceberg_1_1GeospatialBound.html#a23964d7f0b70e89626e27d0f63aa500f">x</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a17c7796d3f77afc3479ca7017464528c">y</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a5919e245b92d705a7d8a82664fe6b3e6">z</a>)</td></tr>
<tr class="memdesc:a71659496f7f313cce12ddaa53c54d368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a bound with a Z coordinate. <br /></td></tr>
<tr class="separator:a71659496f7f313cce12ddaa53c54d368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc65807394273b57fe77619c93735ef" id="r_a4bc65807394273b57fe77619c93735ef"><td class="memItemLeft" align="right" valign="top"><a id="a4bc65807394273b57fe77619c93735ef" name="a4bc65807394273b57fe77619c93735ef"></a>
static <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a>&#160;</td><td class="memItemRight" valign="bottom"><b>XYM</b> (double <a class="el" href="classiceberg_1_1GeospatialBound.html#a23964d7f0b70e89626e27d0f63aa500f">x</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a17c7796d3f77afc3479ca7017464528c">y</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#ae426ca3c35292df9281a2165578f10c3">m</a>)</td></tr>
<tr class="memdesc:a4bc65807394273b57fe77619c93735ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a bound with an M coordinate. <br /></td></tr>
<tr class="separator:a4bc65807394273b57fe77619c93735ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36c67044e926ba48ba3a00845e9603ad" id="r_a36c67044e926ba48ba3a00845e9603ad"><td class="memItemLeft" align="right" valign="top"><a id="a36c67044e926ba48ba3a00845e9603ad" name="a36c67044e926ba48ba3a00845e9603ad"></a>
static <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a>&#160;</td><td class="memItemRight" valign="bottom"><b>XYZM</b> (double <a class="el" href="classiceberg_1_1GeospatialBound.html#a23964d7f0b70e89626e27d0f63aa500f">x</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a17c7796d3f77afc3479ca7017464528c">y</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#a5919e245b92d705a7d8a82664fe6b3e6">z</a>, double <a class="el" href="classiceberg_1_1GeospatialBound.html#ae426ca3c35292df9281a2165578f10c3">m</a>)</td></tr>
<tr class="memdesc:a36c67044e926ba48ba3a00845e9603ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a bound with Z and M coordinates. <br /></td></tr>
<tr class="separator:a36c67044e926ba48ba3a00845e9603ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7911abe6a9649d2532bd27743effbf3" id="r_af7911abe6a9649d2532bd27743effbf3"><td class="memItemLeft" align="right" valign="top"><a id="af7911abe6a9649d2532bd27743effbf3" name="af7911abe6a9649d2532bd27743effbf3"></a>
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Deserialize</b> (std::span&lt; const uint8_t &gt; bytes)</td></tr>
<tr class="memdesc:af7911abe6a9649d2532bd27743effbf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode a little-endian geospatial bound. <br /></td></tr>
<tr class="separator:af7911abe6a9649d2532bd27743effbf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a286d5ef7174e6830c83c526959937f8c" id="r_a286d5ef7174e6830c83c526959937f8c"><td class="memItemLeft" align="right" valign="top"><a id="a286d5ef7174e6830c83c526959937f8c" name="a286d5ef7174e6830c83c526959937f8c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a> &amp;, const <a class="el" href="classiceberg_1_1GeospatialBound.html">GeospatialBound</a> &amp;)=default</td></tr>
<tr class="separator:a286d5ef7174e6830c83c526959937f8c"><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 point used as a lower or upper geospatial column bound. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="geospatial_8h_source.html">geospatial.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>