darkblueb
/
geos_390_docs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
geos_390_docs/classgeos_1_1index_1_1Spati...

316 lines
17 KiB
HTML
Raw Permalink Blame History

<!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::SpatialIndex 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="classgeos_1_1index_1_1SpatialIndex.html">SpatialIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classgeos_1_1index_1_1SpatialIndex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::index::SpatialIndex Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract class defines basic insertion and query operations supported by classes implementing spatial index algorithms.
<a href="classgeos_1_1index_1_1SpatialIndex.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SpatialIndex_8h_source.html">SpatialIndex.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for geos::index::SpatialIndex:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1SpatialIndex__inherit__graph.svg" width="656" height="199"><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:a877d6b8da4c0b28041aeb94297e7021c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html#a877d6b8da4c0b28041aeb94297e7021c">~SpatialIndex</a> ()</td></tr>
<tr class="separator:a877d6b8da4c0b28041aeb94297e7021c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaac40880b4fbc4a32d1d0aba1d679117"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html#aaac40880b4fbc4a32d1d0aba1d679117">insert</a> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *itemEnv, void *item)=0</td></tr>
<tr class="memdesc:aaac40880b4fbc4a32d1d0aba1d679117"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a spatial item with an extent specified by the given Envelope to the index. <a href="#aaac40880b4fbc4a32d1d0aba1d679117">More...</a><br /></td></tr>
<tr class="separator:aaac40880b4fbc4a32d1d0aba1d679117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec3aa2aafa2eff5679c75388afb34ab2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html#aec3aa2aafa2eff5679c75388afb34ab2">query</a> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *searchEnv, std::vector&lt; void * &gt; &amp;)=0</td></tr>
<tr class="memdesc:aec3aa2aafa2eff5679c75388afb34ab2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries the index for all items whose extents intersect the given search Envelope. <a href="#aec3aa2aafa2eff5679c75388afb34ab2">More...</a><br /></td></tr>
<tr class="separator:aec3aa2aafa2eff5679c75388afb34ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab79a4e1da4835cbfa030f25867effcde"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html#ab79a4e1da4835cbfa030f25867effcde">query</a> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *searchEnv, <a class="el" href="classgeos_1_1index_1_1ItemVisitor.html">ItemVisitor</a> &amp;visitor)=0</td></tr>
<tr class="memdesc:ab79a4e1da4835cbfa030f25867effcde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries the index for all items whose extents intersect the given search Envelope and applies an <a class="el" href="classgeos_1_1index_1_1ItemVisitor.html" title="A visitor for items in an index. ">ItemVisitor</a> to them. <a href="#ab79a4e1da4835cbfa030f25867effcde">More...</a><br /></td></tr>
<tr class="separator:ab79a4e1da4835cbfa030f25867effcde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70adf500577ec4c6a595d3d26196eb04"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html#a70adf500577ec4c6a595d3d26196eb04">remove</a> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *itemEnv, void *item)=0</td></tr>
<tr class="memdesc:a70adf500577ec4c6a595d3d26196eb04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a single item from the tree. <a href="#a70adf500577ec4c6a595d3d26196eb04">More...</a><br /></td></tr>
<tr class="separator:a70adf500577ec4c6a595d3d26196eb04"><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>Abstract class defines basic insertion and query operations supported by classes implementing spatial index algorithms. </p>
<p>A spatial index typically provides a primary filter for range rectangle queries. A secondary filter is required to test for exact intersection. Of course, this secondary filter may consist of other tests besides intersection, such as testing other kinds of spatial relationships.</p>
<p>Last port: index/SpatialIndex.java rev. 1.11 (JTS-1.7) </p>
<p>Definition at line <a class="el" href="SpatialIndex_8h_source.html#l00047">47</a> of file <a class="el" href="SpatialIndex_8h_source.html">SpatialIndex.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a877d6b8da4c0b28041aeb94297e7021c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual geos::index::SpatialIndex::~SpatialIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SpatialIndex_8h_source.html#l00051">51</a> of file <a class="el" href="SpatialIndex_8h_source.html">SpatialIndex.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aaac40880b4fbc4a32d1d0aba1d679117"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void geos::index::SpatialIndex::insert </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *&#160;</td>
<td class="paramname"><em>itemEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>item</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a spatial item with an extent specified by the given Envelope to the index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemEnv</td><td>Envelope of the item, ownership left to caller. TODO: Reference hold by this class ?</td></tr>
<tr><td class="paramname">item</td><td>Opaque item, ownership left to caller. Reference hold by this class. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRtree.html#a72054c47a12ba5bf1190a8ab23fc7cd9">geos::index::strtree::SimpleSTRtree</a>, <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a9ca89d79af23375493acbc8286e7e3e4">geos::index::strtree::STRtree</a>, and <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Quadtree.html#ace675add240510cea1486eb5daf0c062">geos::index::quadtree::Quadtree</a>.</p>
</div>
</div>
<a class="anchor" id="aec3aa2aafa2eff5679c75388afb34ab2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void geos::index::SpatialIndex::query </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *&#160;</td>
<td class="paramname"><em>searchEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; void * &gt; &amp;&#160;</td>
<td class="paramname">&#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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the index for all items whose extents intersect the given search Envelope. </p>
<p>Note that some kinds of indexes may also return objects which do not in fact intersect the query envelope.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">searchEnv</td><td>the envelope to query for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a list of the items found by the query in a newly allocated vector </dd></dl>
<p>Implemented in <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRtree.html#a3cf8152f97246edd336f6ed54b5a5568">geos::index::strtree::SimpleSTRtree</a>, <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#aa31a264493ad5a307769c1feb67d1371">geos::index::strtree::STRtree</a>, and <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Quadtree.html#ad8c1eb5215ad191bfbd38e8936677e72">geos::index::quadtree::Quadtree</a>.</p>
</div>
</div>
<a class="anchor" id="ab79a4e1da4835cbfa030f25867effcde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void geos::index::SpatialIndex::query </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *&#160;</td>
<td class="paramname"><em>searchEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1ItemVisitor.html">ItemVisitor</a> &amp;&#160;</td>
<td class="paramname"><em>visitor</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the index for all items whose extents intersect the given search Envelope and applies an <a class="el" href="classgeos_1_1index_1_1ItemVisitor.html" title="A visitor for items in an index. ">ItemVisitor</a> to them. </p>
<p>Note that some kinds of indexes may also return objects which do not in fact intersect the query envelope.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">searchEnv</td><td>the envelope to query for </td></tr>
<tr><td class="paramname">visitor</td><td>a visitor object to apply to the items found </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Quadtree.html#a4f688e0830d53e6ec3ba397f606e9008">geos::index::quadtree::Quadtree</a>, <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRtree.html#a38c10b235bc266141f3d561f714f67c5">geos::index::strtree::SimpleSTRtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a4e3e30e9905a1abe0cd2db1c2c98d32f">geos::index::strtree::STRtree</a>.</p>
</div>
</div>
<a class="anchor" id="a70adf500577ec4c6a595d3d26196eb04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool geos::index::SpatialIndex::remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> *&#160;</td>
<td class="paramname"><em>itemEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>item</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a single item from the tree. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemEnv</td><td>the Envelope of the item to remove </td></tr>
<tr><td class="paramname">item</td><td>the item to remove </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the item was found </dd></dl>
<p>Implemented in <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Quadtree.html#a30af72119aa17b1a34442e9291aa7b4b">geos::index::quadtree::Quadtree</a>, <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#ac245d85d6fd3dad87c2628834e790d72">geos::index::strtree::STRtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRtree.html#a01f981639612d817a82d80be421c27ff">geos::index::strtree::SimpleSTRtree</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SpatialIndex_8h_source.html">SpatialIndex.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>
Reference in New Issue View Git Blame Copy Permalink