geos_390_docs/classgeos_1_1algorithm_1_1l...

340 lines
20 KiB
HTML

<!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::algorithm::locate::IndexedPointInAreaLocator 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_1algorithm.html">algorithm</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1algorithm_1_1locate.html">locate</a></li><li class="navelem"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::algorithm::locate::IndexedPointInAreaLocator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Determines the location of <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinates</a> relative to an areal geometry, using indexing for efficiency.
<a href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for geos::algorithm::locate::IndexedPointInAreaLocator:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator__inherit__graph.svg" width="216" 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>
<div class="dynheader">
Collaboration diagram for geos::algorithm::locate::IndexedPointInAreaLocator:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator__coll__graph.svg" width="100%" height="431"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator_1_1IntervalIndexedGeometry.html">IntervalIndexedGeometry</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator_1_1SegmentVisitor.html">SegmentVisitor</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a4354cd8b0102df695aa7d79e463110bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a4354cd8b0102df695aa7d79e463110bc">IndexedPointInAreaLocator</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;g)</td></tr>
<tr class="memdesc:a4354cd8b0102df695aa7d79e463110bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new locator for a given <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. <a href="#a4354cd8b0102df695aa7d79e463110bc">More...</a><br /></td></tr>
<tr class="separator:a4354cd8b0102df695aa7d79e463110bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe0dfe0b490f81840d4638a2c8a281f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a6fe0dfe0b490f81840d4638a2c8a281f">getGeometry</a> () const </td></tr>
<tr class="separator:a6fe0dfe0b490f81840d4638a2c8a281f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade20d94a193f206a58efcf8ccea8ef9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#ade20d94a193f206a58efcf8ccea8ef9b">locate</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> *p) override</td></tr>
<tr class="memdesc:ade20d94a193f206a58efcf8ccea8ef9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">Location</a> of a point in an areal <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. <a href="#ade20d94a193f206a58efcf8ccea8ef9b">More...</a><br /></td></tr>
<tr class="separator:ade20d94a193f206a58efcf8ccea8ef9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator.html">geos::algorithm::locate::PointOnGeometryLocator</a></td></tr>
<tr class="memitem:a42638ca7c44b96590848fd726941d800 inherit pub_methods_classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator.html#a42638ca7c44b96590848fd726941d800">~PointOnGeometryLocator</a> ()</td></tr>
<tr class="separator:a42638ca7c44b96590848fd726941d800 inherit pub_methods_classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ab5add4c9e866b0a72aad2f38eff04c97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#ab5add4c9e866b0a72aad2f38eff04c97">buildIndex</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;g)</td></tr>
<tr class="separator:ab5add4c9e866b0a72aad2f38eff04c97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21c15c8be55a15c875ecc93409558376"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a21c15c8be55a15c875ecc93409558376">IndexedPointInAreaLocator</a> (const <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a> &amp;other)=delete</td></tr>
<tr class="separator:a21c15c8be55a15c875ecc93409558376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a389d865b2e03979057134a0e8fcc05cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a389d865b2e03979057134a0e8fcc05cc">operator=</a> (const <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a> &amp;rhs)=delete</td></tr>
<tr class="separator:a389d865b2e03979057134a0e8fcc05cc"><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:a470b2f8b4e07015ca71f50270debffb4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a470b2f8b4e07015ca71f50270debffb4">areaGeom</a></td></tr>
<tr class="separator:a470b2f8b4e07015ca71f50270debffb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c173f4e8e1037659563a267a8b2d0bf"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator_1_1IntervalIndexedGeometry.html">IntervalIndexedGeometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html#a9c173f4e8e1037659563a267a8b2d0bf">index</a></td></tr>
<tr class="separator:a9c173f4e8e1037659563a267a8b2d0bf"><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>Determines the location of <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinates</a> relative to an areal geometry, using indexing for efficiency. </p>
<p>The Location is computed precisely, in that points located on the geometry boundary or segments will return <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location::BOUNDARY</a>.</p>
<p>Polygonal and <a class="el" href="classgeos_1_1geom_1_1LinearRing.html">LinearRing</a> geometries are supported.</p>
<p>The index is lazy-loaded, which allows creating instances even if they are not used. </p>
<p>Definition at line <a class="el" href="IndexedPointInAreaLocator_8h_source.html#l00055">55</a> of file <a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a21c15c8be55a15c875ecc93409558376"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::algorithm::locate::IndexedPointInAreaLocator::IndexedPointInAreaLocator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4354cd8b0102df695aa7d79e463110bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::algorithm::locate::IndexedPointInAreaLocator::IndexedPointInAreaLocator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new locator for a given <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. </p>
<p>Polygonal and <a class="el" href="classgeos_1_1geom_1_1LinearRing.html">LinearRing</a> geometries are supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">g</td><td>the Geometry to locate in </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab5add4c9e866b0a72aad2f38eff04c97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::algorithm::locate::IndexedPointInAreaLocator::buildIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &amp;&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6fe0dfe0b490f81840d4638a2c8a281f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&amp; geos::algorithm::locate::IndexedPointInAreaLocator::getGeometry </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="IndexedPointInAreaLocator_8h_source.html#l00110">110</a> of file <a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.h</a>.</p>
</div>
</div>
<a class="anchor" id="ade20d94a193f206a58efcf8ccea8ef9b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> geos::algorithm::locate::IndexedPointInAreaLocator::locate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></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>Determines the <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">Location</a> of a point in an areal <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the point to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the location of the point in the geometry </dd></dl>
<p>Implements <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1PointOnGeometryLocator.html#a087b89fa4cd7ece8b07c8a8915523ca9">geos::algorithm::locate::PointOnGeometryLocator</a>.</p>
</div>
</div>
<a class="anchor" id="a389d865b2e03979057134a0e8fcc05cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a>&amp; geos::algorithm::locate::IndexedPointInAreaLocator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator.html">IndexedPointInAreaLocator</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a470b2f8b4e07015ca71f50270debffb4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&amp; geos::algorithm::locate::IndexedPointInAreaLocator::areaGeom</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="IndexedPointInAreaLocator_8h_source.html#l00091">91</a> of file <a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9c173f4e8e1037659563a267a8b2d0bf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgeos_1_1algorithm_1_1locate_1_1IndexedPointInAreaLocator_1_1IntervalIndexedGeometry.html">IntervalIndexedGeometry</a>&gt; geos::algorithm::locate::IndexedPointInAreaLocator::index</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="IndexedPointInAreaLocator_8h_source.html#l00092">92</a> of file <a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="IndexedPointInAreaLocator_8h_source.html">IndexedPointInAreaLocator.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>