blob: 72766bf14216282d510f61982718376098b2f6f2 [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::StructLikeAccessor 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_1StructLikeAccessor.html">StructLikeAccessor</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_1StructLikeAccessor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::StructLikeAccessor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>An accessor for a struct-like object.
<a href="classiceberg_1_1StructLikeAccessor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="struct__like_8h_source.html">struct_like.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:a336853e36bf67a305a3569141aeea976" id="r_a336853e36bf67a305a3569141aeea976"><td class="memItemLeft" align="right" valign="top"><a id="a336853e36bf67a305a3569141aeea976" name="a336853e36bf67a305a3569141aeea976"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StructLikeAccessor</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; <a class="el" href="classiceberg_1_1StructLikeAccessor.html#aa3b945081589837e6c30b290174874c7">type</a>, std::span&lt; const size_t &gt; <a class="el" href="classiceberg_1_1StructLikeAccessor.html#a2dd0c8c322eb750c08f31100258a8c6f">position_path</a>)</td></tr>
<tr class="separator:a336853e36bf67a305a3569141aeea976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aece7efe1b080bf203dabed4da1ce56d9" id="r_aece7efe1b080bf203dabed4da1ce56d9"><td class="memItemLeft" align="right" valign="top"><a id="aece7efe1b080bf203dabed4da1ce56d9" name="aece7efe1b080bf203dabed4da1ce56d9"></a>
Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Get</b> (const <a class="el" href="classiceberg_1_1StructLike.html">StructLike</a> &amp;struct_like) const</td></tr>
<tr class="memdesc:aece7efe1b080bf203dabed4da1ce56d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the scalar value at the given position. <br /></td></tr>
<tr class="separator:aece7efe1b080bf203dabed4da1ce56d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f640dcbadd020a8d859fb1edc6c6ed2" id="r_a3f640dcbadd020a8d859fb1edc6c6ed2"><td class="memItemLeft" align="right" valign="top">Result&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructLikeAccessor.html#a3f640dcbadd020a8d859fb1edc6c6ed2">GetLiteral</a> (const <a class="el" href="classiceberg_1_1StructLike.html">StructLike</a> &amp;struct_like) const</td></tr>
<tr class="memdesc:a3f640dcbadd020a8d859fb1edc6c6ed2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the literal value at the given position. <br /></td></tr>
<tr class="separator:a3f640dcbadd020a8d859fb1edc6c6ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b945081589837e6c30b290174874c7" id="r_aa3b945081589837e6c30b290174874c7"><td class="memItemLeft" align="right" valign="top"><a id="aa3b945081589837e6c30b290174874c7" name="aa3b945081589837e6c30b290174874c7"></a>
const <a class="el" href="classiceberg_1_1Type.html">Type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>type</b> () const</td></tr>
<tr class="memdesc:aa3b945081589837e6c30b290174874c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of the value that this accessor is bound to. <br /></td></tr>
<tr class="separator:aa3b945081589837e6c30b290174874c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dd0c8c322eb750c08f31100258a8c6f" id="r_a2dd0c8c322eb750c08f31100258a8c6f"><td class="memItemLeft" align="right" valign="top"><a id="a2dd0c8c322eb750c08f31100258a8c6f" name="a2dd0c8c322eb750c08f31100258a8c6f"></a>
const std::vector&lt; size_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>position_path</b> () const</td></tr>
<tr class="memdesc:a2dd0c8c322eb750c08f31100258a8c6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the position path of the value that this accessor bounded to. <br /></td></tr>
<tr class="separator:a2dd0c8c322eb750c08f31100258a8c6f"><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>An accessor for a struct-like object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3f640dcbadd020a8d859fb1edc6c6ed2" name="a3f640dcbadd020a8d859fb1edc6c6ed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f640dcbadd020a8d859fb1edc6c6ed2">&#9670;&#160;</a></span>GetLiteral()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; iceberg::StructLikeAccessor::GetLiteral </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1StructLike.html">StructLike</a> &amp;&#160;</td>
<td class="paramname"><em>struct_like</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the literal value at the given position. </p>
<dl class="section return"><dt>Returns</dt><dd>The literal value at the given position, or an error if it is not a primitive type. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/row/<a class="el" href="struct__like_8h_source.html">struct_like.h</a></li>
<li>iceberg/row/<b>struct_like.cc</b></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>