geos_390_docs/classgeos_1_1index_1_1strtr...

<!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>GEOS: geos::index::strtree::ItemBoundable 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="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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GEOS
   &#160;<span id="projectnumber">3.9.1dev</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index.html">index</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index_1_1strtree.html">strtree</a></li><li class="navelem"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundable</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1index_1_1strtree_1_1ItemBoundable-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">geos::index::strtree::ItemBoundable Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html" title="A spatial object in an AbstractSTRtree. ">Boundable</a> wrapper for a non-Boundable spatial object. Used internally by <a class="el" href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html" title="Base class for STRtree and SIRtree. ">AbstractSTRtree</a>.
 <a href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for geos::index::strtree::ItemBoundable:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1ItemBoundable__inherit__graph.svg" width="155" height="239"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for geos::index::strtree::ItemBoundable:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1ItemBoundable__coll__graph.svg" width="155" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ad7be7ddbd47ede6b8d543175d5b0d679"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#ad7be7ddbd47ede6b8d543175d5b0d679">ItemBoundable</a> (const void *newBounds, void *newItem)</td></tr>
<tr class="separator:ad7be7ddbd47ede6b8d543175d5b0d679"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acafd0facee17aae528c5106c2ccddeab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#acafd0facee17aae528c5106c2ccddeab">~ItemBoundable</a> () override=default</td></tr>
<tr class="separator:acafd0facee17aae528c5106c2ccddeab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacbdcab5c928de38db2a2c4fde207ac8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#aacbdcab5c928de38db2a2c4fde207ac8">isLeaf</a> () const override</td></tr>
<tr class="separator:aacbdcab5c928de38db2a2c4fde207ac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31a8f10fb2275885fbd4840306c5b78c"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#a31a8f10fb2275885fbd4840306c5b78c">getBounds</a> () const override</td></tr>
<tr class="separator:a31a8f10fb2275885fbd4840306c5b78c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6c15d9b50e76371dd414beac1f9d04"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#aeb6c15d9b50e76371dd414beac1f9d04">getItem</a> () const </td></tr>
<tr class="separator:aeb6c15d9b50e76371dd414beac1f9d04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgeos_1_1index_1_1strtree_1_1Boundable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgeos_1_1index_1_1strtree_1_1Boundable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">geos::index::strtree::Boundable</a></td></tr>
<tr class="memitem:aa2a6da63ed2298854d4833e70b9c04b8 inherit pub_methods_classgeos_1_1index_1_1strtree_1_1Boundable"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html#aa2a6da63ed2298854d4833e70b9c04b8">~Boundable</a> ()</td></tr>
<tr class="separator:aa2a6da63ed2298854d4833e70b9c04b8 inherit pub_methods_classgeos_1_1index_1_1strtree_1_1Boundable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af81c90aa3fb15c52082270f18d5d7b5d"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#af81c90aa3fb15c52082270f18d5d7b5d">bounds</a></td></tr>
<tr class="separator:af81c90aa3fb15c52082270f18d5d7b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa576fc5d6c276a7743a568408545b32d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html#aa576fc5d6c276a7743a568408545b32d">item</a></td></tr>
<tr class="separator:aa576fc5d6c276a7743a568408545b32d"><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 class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html" title="A spatial object in an AbstractSTRtree. ">Boundable</a> wrapper for a non-Boundable spatial object. Used internally by <a class="el" href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html" title="Base class for STRtree and SIRtree. ">AbstractSTRtree</a>. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>TODO: It's unclear who takes ownership of passed newBounds and newItem objects. </dd></dl>

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00032">32</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad7be7ddbd47ede6b8d543175d5b0d679"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">geos::index::strtree::ItemBoundable::ItemBoundable </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>newBounds</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>newItem</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00035">35</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<a class="anchor" id="acafd0facee17aae528c5106c2ccddeab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">geos::index::strtree::ItemBoundable::~ItemBoundable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a31a8f10fb2275885fbd4840306c5b78c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const void* geos::index::strtree::ItemBoundable::getBounds </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">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a representation of space that encloses this <a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html" title="A spatial object in an AbstractSTRtree. ">Boundable</a>, preferably not much bigger than this <a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html" title="A spatial object in an AbstractSTRtree. ">Boundable</a>'s boundary yet fast to test for intersection with the bounds of other Boundables.</p>
<p>The class of object returned depends on the subclass of <a class="el" href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html" title="Base class for STRtree and SIRtree. ">AbstractSTRtree</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>an Envelope (for STRtrees), an <a class="el" href="classgeos_1_1index_1_1strtree_1_1Interval.html" title="A contiguous portion of 1D-space. Used internally by SIRtree. ">Interval</a> (for SIRtrees), or other object (for other subclasses of <a class="el" href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html" title="Base class for STRtree and SIRtree. ">AbstractSTRtree</a>)</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_1_1IntersectsOp.html" title="A test for intersection between two bounds, necessary because subclasses of AbstractSTRtree have diff...">AbstractSTRtree::IntersectsOp</a> </dd></dl>

<p>Implements <a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html#abc2553f6281be88e0266a7bf02c566d0">geos::index::strtree::Boundable</a>.</p>

<p>Reimplemented in <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html#aef57a8b78bde5985a218a65cc8f51ce0">geos::index::strtree::SimpleSTRnode</a>.</p>

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00042">42</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<a class="anchor" id="aeb6c15d9b50e76371dd414beac1f9d04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void* geos::index::strtree::ItemBoundable::getItem </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00046">46</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<a class="anchor" id="aacbdcab5c928de38db2a2c4fde207ac8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool geos::index::strtree::ItemBoundable::isLeaf </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">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classgeos_1_1index_1_1strtree_1_1Boundable.html#a9e65c209a42b6499e1abeb5bebe55a40">geos::index::strtree::Boundable</a>.</p>

<p>Reimplemented in <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html#a6b36d4cb5f0fcc216cef4e3d85203515">geos::index::strtree::SimpleSTRnode</a>.</p>

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00038">38</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af81c90aa3fb15c52082270f18d5d7b5d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const void* geos::index::strtree::ItemBoundable::bounds</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00052">52</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa576fc5d6c276a7743a568408545b32d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void* geos::index::strtree::ItemBoundable::item</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="ItemBoundable_8h_source.html#l00053">53</a> of file <a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ItemBoundable_8h_source.html">ItemBoundable.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>