<!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"/>
<title>GEOS: geos::index::SpatialIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related 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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacegeos.html">geos</a> </li>
<li><a class="el" href="namespacegeos_1_1index.html">index</a> </li>
<li><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">geos::index::SpatialIndex</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::index::SpatialIndex Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::index::SpatialIndex" -->
<p>Abstract class defines basic insertion and query operations supported by classes implementing spatial index algorithms.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="SpatialIndex_8h_source.html">SpatialIndex.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::index::SpatialIndex:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1index_1_1SpatialIndex.png" usemap="#geos::index::SpatialIndex_map" alt=""/>
<map id="geos::index::SpatialIndex_map" name="geos::index::SpatialIndex_map">
<area href="classgeos_1_1index_1_1quadtree_1_1Quadtree.html" alt="geos::index::quadtree::Quadtree" shape="rect" coords="0,56,189,80"/>
<area href="classgeos_1_1index_1_1strtree_1_1STRtree.html" alt="geos::index::strtree::STRtree" shape="rect" coords="199,56,388,80"/>
</map>
</div>
<p><a href="classgeos_1_1index_1_1SpatialIndex-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </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><td class="mdescLeft"> </td><td class="mdescRight">Adds a spatial item with an extent specified by the given Envelope to the index. <a href="#aaac40880b4fbc4a32d1d0aba1d679117"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </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< void * > &)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries the index for all items whose extents intersect the given search Envelope. <a href="#aec3aa2aafa2eff5679c75388afb34ab2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </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> &visitor)=0</td></tr>
<tr><td class="mdescLeft"> </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"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </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><td class="mdescLeft"> </td><td class="mdescRight">Removes a single item from the tree. <a href="#a70adf500577ec4c6a595d3d26196eb04"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaac40880b4fbc4a32d1d0aba1d679117"></a><!-- doxytag: member="geos::index::SpatialIndex::insert" ref="aaac40880b4fbc4a32d1d0aba1d679117" args="(const geom::Envelope *itemEnv, void *item)=0" -->
<div class="memitem">
<div class="memproto">
<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> * </td>
<td class="paramname"> <em>itemEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>itemEnv</em> </td><td>Envelope of the item, ownership left to caller. TODO: Reference hold by this class ?</td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </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_1quadtree_1_1Quadtree.html#a771b5ee5c0d638a145ae675e11308963">geos::index::quadtree::Quadtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a3a1e68a5099dc855b86604b2dde7e03f">geos::index::strtree::STRtree</a>.</p>
</div>
</div>
<a class="anchor" id="aec3aa2aafa2eff5679c75388afb34ab2"></a><!-- doxytag: member="geos::index::SpatialIndex::query" ref="aec3aa2aafa2eff5679c75388afb34ab2" args="(const geom::Envelope *searchEnv, std::vector< void * > &)=0" -->
<div class="memitem">
<div class="memproto">
<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> * </td>
<td class="paramname"> <em>searchEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< void * > & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>searchEnv</em> </td><td>the envelope to query for </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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_1quadtree_1_1Quadtree.html#aeff52411e953a7da9bf3083004686d19">geos::index::quadtree::Quadtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#ada94f2eeb8cc1edcdfa346e04bf0f977">geos::index::strtree::STRtree</a>.</p>
</div>
</div>
<a class="anchor" id="ab79a4e1da4835cbfa030f25867effcde"></a><!-- doxytag: member="geos::index::SpatialIndex::query" ref="ab79a4e1da4835cbfa030f25867effcde" args="(const geom::Envelope *searchEnv, ItemVisitor &visitor)=0" -->
<div class="memitem">
<div class="memproto">
<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> * </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> & </td>
<td class="paramname"> <em>visitor</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>searchEnv</em> </td><td>the envelope to query for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>visitor</em> </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#a1e753c1c2c00f9d05bdf7041ce95bbb0">geos::index::quadtree::Quadtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a4a2fc9d3c2c03577bb4c5b3897c55188">geos::index::strtree::STRtree</a>.</p>
</div>
</div>
<a class="anchor" id="a70adf500577ec4c6a595d3d26196eb04"></a><!-- doxytag: member="geos::index::SpatialIndex::remove" ref="a70adf500577ec4c6a595d3d26196eb04" args="(const geom::Envelope *itemEnv, void *item)=0" -->
<div class="memitem">
<div class="memproto">
<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> * </td>
<td class="paramname"> <em>itemEnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a single item from the tree. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>itemEnv</em> </td><td>the Envelope of the item to remove </td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>the item to remove </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#af15851c5095fbb798d86aa58c03ad341">geos::index::quadtree::Quadtree</a>, and <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html#aecffa6cb4487b6af60f19e7a0ee71e05">geos::index::strtree::STRtree</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>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
