| <!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::SortField 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&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&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_1SortField.html">SortField</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classiceberg_1_1SortField-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SortField Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>a field with its transform. |
| <a href="classiceberg_1_1SortField.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="sort__field_8h_source.html">sort_field.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::SortField:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1SortField.png" usemap="#iceberg::SortField_map" alt=""/> |
| <map id="iceberg::SortField_map" name="iceberg::SortField_map"> |
| <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="0,0,149,24"/> |
| </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:ae538f9629f084c1c8d00e030deb7832a" id="r_ae538f9629f084c1c8d00e030deb7832a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortField.html#ae538f9629f084c1c8d00e030deb7832a">SortField</a> (int32_t <a class="el" href="classiceberg_1_1SortField.html#af05fd46217b7086648bcda9c065cfa47">source_id</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > <a class="el" href="classiceberg_1_1SortField.html#a73926ec663830ae08f9c283348097357">transform</a>, <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">SortDirection</a> <a class="el" href="classiceberg_1_1SortField.html#a620ff18cb7784e23042395a99fac8ee6">direction</a>, <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">NullOrder</a> <a class="el" href="classiceberg_1_1SortField.html#a8b8d824a9a5adbc0c1e0164be609c11d">null_order</a>)</td></tr> |
| <tr class="memdesc:ae538f9629f084c1c8d00e030deb7832a"><td class="mdescLeft"> </td><td class="mdescRight">Construct a field. <br /></td></tr> |
| <tr class="separator:ae538f9629f084c1c8d00e030deb7832a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af05fd46217b7086648bcda9c065cfa47" id="r_af05fd46217b7086648bcda9c065cfa47"><td class="memItemLeft" align="right" valign="top"><a id="af05fd46217b7086648bcda9c065cfa47" name="af05fd46217b7086648bcda9c065cfa47"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>source_id</b> () const</td></tr> |
| <tr class="memdesc:af05fd46217b7086648bcda9c065cfa47"><td class="mdescLeft"> </td><td class="mdescRight">Get the source field ID. <br /></td></tr> |
| <tr class="separator:af05fd46217b7086648bcda9c065cfa47"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a73926ec663830ae08f9c283348097357" id="r_a73926ec663830ae08f9c283348097357"><td class="memItemLeft" align="right" valign="top"><a id="a73926ec663830ae08f9c283348097357" name="a73926ec663830ae08f9c283348097357"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > & </td><td class="memItemRight" valign="bottom"><b>transform</b> () const</td></tr> |
| <tr class="memdesc:a73926ec663830ae08f9c283348097357"><td class="mdescLeft"> </td><td class="mdescRight">Get the transform type. <br /></td></tr> |
| <tr class="separator:a73926ec663830ae08f9c283348097357"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a620ff18cb7784e23042395a99fac8ee6" id="r_a620ff18cb7784e23042395a99fac8ee6"><td class="memItemLeft" align="right" valign="top"><a id="a620ff18cb7784e23042395a99fac8ee6" name="a620ff18cb7784e23042395a99fac8ee6"></a> |
| <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">SortDirection</a> </td><td class="memItemRight" valign="bottom"><b>direction</b> () const</td></tr> |
| <tr class="memdesc:a620ff18cb7784e23042395a99fac8ee6"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort direction. <br /></td></tr> |
| <tr class="separator:a620ff18cb7784e23042395a99fac8ee6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b8d824a9a5adbc0c1e0164be609c11d" id="r_a8b8d824a9a5adbc0c1e0164be609c11d"><td class="memItemLeft" align="right" valign="top"><a id="a8b8d824a9a5adbc0c1e0164be609c11d" name="a8b8d824a9a5adbc0c1e0164be609c11d"></a> |
| <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">NullOrder</a> </td><td class="memItemRight" valign="bottom"><b>null_order</b> () const</td></tr> |
| <tr class="memdesc:a8b8d824a9a5adbc0c1e0164be609c11d"><td class="mdescLeft"> </td><td class="mdescRight">Get the null order. <br /></td></tr> |
| <tr class="separator:a8b8d824a9a5adbc0c1e0164be609c11d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4356f8651d272be36c517cf0db336122" id="r_a4356f8651d272be36c517cf0db336122"><td class="memItemLeft" align="right" valign="top"><a id="a4356f8651d272be36c517cf0db336122" name="a4356f8651d272be36c517cf0db336122"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>Satisfies</b> (const <a class="el" href="classiceberg_1_1SortField.html">SortField</a> &other) const</td></tr> |
| <tr class="memdesc:a4356f8651d272be36c517cf0db336122"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this field's order satisfies another field's order. <br /></td></tr> |
| <tr class="separator:a4356f8651d272be36c517cf0db336122"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e78bbc2959d854d6b8700b00e7453a9" id="r_a0e78bbc2959d854d6b8700b00e7453a9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortField.html#a0e78bbc2959d854d6b8700b00e7453a9">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a0e78bbc2959d854d6b8700b00e7453a9"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a0e78bbc2959d854d6b8700b00e7453a9"><td class="memSeparator" colspan="2"> </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:aed0b644de41cdbff98c44d5706dd33a9" id="r_aed0b644de41cdbff98c44d5706dd33a9"><td class="memItemLeft" align="right" valign="top"><a id="aed0b644de41cdbff98c44d5706dd33a9" name="aed0b644de41cdbff98c44d5706dd33a9"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1SortField.html">SortField</a> &lhs, const <a class="el" href="classiceberg_1_1SortField.html">SortField</a> &rhs)</td></tr> |
| <tr class="separator:aed0b644de41cdbff98c44d5706dd33a9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>a field with its transform. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ae538f9629f084c1c8d00e030deb7832a" name="ae538f9629f084c1c8d00e030deb7832a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae538f9629f084c1c8d00e030deb7832a">◆ </a></span>SortField()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::SortField::SortField </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>source_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td> |
| <td class="paramname"><em>transform</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">SortDirection</a> </td> |
| <td class="paramname"><em>direction</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">NullOrder</a> </td> |
| <td class="paramname"><em>null_order</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a field. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">source_id</td><td>The source field ID. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">transform</td><td>The transform function. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>The sort direction. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">null_order</td><td>The null order. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0e78bbc2959d854d6b8700b00e7453a9" name="a0e78bbc2959d854d6b8700b00e7453a9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0e78bbc2959d854d6b8700b00e7453a9">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string iceberg::SortField::ToString </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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a user-readable string representation. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="sort__field_8h_source.html">sort_field.h</a></li> |
| <li>iceberg/<b>sort_field.cc</b></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
