geos_390_docs/classgeos_1_1operation_1_1v...

344 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::operation::valid::ConsistentAreaTester 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_1operation.html">operation</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1operation_1_1valid.html">valid</a></li><li class="navelem"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html">ConsistentAreaTester</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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_1operation_1_1valid_1_1ConsistentAreaTester-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::operation::valid::ConsistentAreaTester Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Checks that a <a class="el" href="classgeos_1_1geomgraph_1_1GeometryGraph.html" title="A GeometryGraph is a graph that models a given Geometry. ">geomgraph::GeometryGraph</a> representing an area (a <a class="el" href="classgeos_1_1geom_1_1Polygon.html" title="Represents a linear polygon, which may include holes. ">geom::Polygon</a> or <a class="el" href="classgeos_1_1geom_1_1MultiPolygon.html">geom::MultiPolygon</a>) has consistent semantics for area geometries. This check is required for any reasonable polygonal model (including the OGC-SFS model, as well as models which allow ring self-intersection at single points)
<a href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::operation::valid::ConsistentAreaTester:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester__coll__graph.svg" width="100%" height="591"><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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a964b213d70993f3ed9c71b1555cc9abd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a964b213d70993f3ed9c71b1555cc9abd">ConsistentAreaTester</a> (<a class="el" href="classgeos_1_1geomgraph_1_1GeometryGraph.html">geomgraph::GeometryGraph</a> *newGeomGraph)</td></tr>
<tr class="separator:a964b213d70993f3ed9c71b1555cc9abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe022bb017724de9bc7fa026747be93b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#afe022bb017724de9bc7fa026747be93b">~ConsistentAreaTester</a> ()=default</td></tr>
<tr class="separator:afe022bb017724de9bc7fa026747be93b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae7663edf982238c84836029a858a8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a0ae7663edf982238c84836029a858a8e">getInvalidPoint</a> ()</td></tr>
<tr class="separator:a0ae7663edf982238c84836029a858a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4772f1fd7dd9c24aa2d5ed38f107bcf8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a4772f1fd7dd9c24aa2d5ed38f107bcf8">isNodeConsistentArea</a> ()</td></tr>
<tr class="memdesc:a4772f1fd7dd9c24aa2d5ed38f107bcf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check all nodes to see if their labels are consistent with area topology. <a href="#a4772f1fd7dd9c24aa2d5ed38f107bcf8">More...</a><br /></td></tr>
<tr class="separator:a4772f1fd7dd9c24aa2d5ed38f107bcf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a380c67355ef80015402cc5ff0770be32"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a380c67355ef80015402cc5ff0770be32">hasDuplicateRings</a> ()</td></tr>
<tr class="separator:a380c67355ef80015402cc5ff0770be32"><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:ac04bab075a69fe57fc27470d1619b510"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#ac04bab075a69fe57fc27470d1619b510">isNodeEdgeAreaLabelsConsistent</a> ()</td></tr>
<tr class="separator:ac04bab075a69fe57fc27470d1619b510"><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:a832d443a49a84fd4f3349c9ef6cb82e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1algorithm_1_1LineIntersector.html">algorithm::LineIntersector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a832d443a49a84fd4f3349c9ef6cb82e6">li</a></td></tr>
<tr class="separator:a832d443a49a84fd4f3349c9ef6cb82e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e9ddbf9d001b6e8e1f6e96f3935b682"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geomgraph_1_1GeometryGraph.html">geomgraph::GeometryGraph</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a9e9ddbf9d001b6e8e1f6e96f3935b682">geomGraph</a></td></tr>
<tr class="memdesc:a9e9ddbf9d001b6e8e1f6e96f3935b682"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not owned. <a href="#a9e9ddbf9d001b6e8e1f6e96f3935b682">More...</a><br /></td></tr>
<tr class="separator:a9e9ddbf9d001b6e8e1f6e96f3935b682"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac425d9f02b9b30412b72514cbc5ceba7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateNodeGraph.html">relate::RelateNodeGraph</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#ac425d9f02b9b30412b72514cbc5ceba7">nodeGraph</a></td></tr>
<tr class="separator:ac425d9f02b9b30412b72514cbc5ceba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f4aa5e869917969262717dc628e4eb3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1valid_1_1ConsistentAreaTester.html#a5f4aa5e869917969262717dc628e4eb3">invalidPoint</a></td></tr>
<tr class="memdesc:a5f4aa5e869917969262717dc628e4eb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">the intersection point found (if any) <a href="#a5f4aa5e869917969262717dc628e4eb3">More...</a><br /></td></tr>
<tr class="separator:a5f4aa5e869917969262717dc628e4eb3"><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>Checks that a <a class="el" href="classgeos_1_1geomgraph_1_1GeometryGraph.html" title="A GeometryGraph is a graph that models a given Geometry. ">geomgraph::GeometryGraph</a> representing an area (a <a class="el" href="classgeos_1_1geom_1_1Polygon.html" title="Represents a linear polygon, which may include holes. ">geom::Polygon</a> or <a class="el" href="classgeos_1_1geom_1_1MultiPolygon.html">geom::MultiPolygon</a>) has consistent semantics for area geometries. This check is required for any reasonable polygonal model (including the OGC-SFS model, as well as models which allow ring self-intersection at single points) </p>
<p>Checks include:</p>
<ul>
<li>test for rings which properly intersect (but not for ring self-intersection, or intersections at vertices)</li>
<li>test for consistent labelling at all node points (this detects vertex intersections with invalid topology, i.e. where the exterior side of an edge lies in the interior of the area)</li>
<li>test for duplicate rings</li>
</ul>
<p>If an inconsistency is found the location of the problem is recorded and is available to the caller. </p>
<p>Definition at line <a class="el" href="ConsistentAreaTester_8h_source.html#l00069">69</a> of file <a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a964b213d70993f3ed9c71b1555cc9abd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::valid::ConsistentAreaTester::ConsistentAreaTester </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1geomgraph_1_1GeometryGraph.html">geomgraph::GeometryGraph</a> *&#160;</td>
<td class="paramname"><em>newGeomGraph</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new tester for consistent areas.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newGeomGraph</td><td>the topology graph of the area geometry. Caller keeps responsibility for its deletion </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afe022bb017724de9bc7fa026747be93b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::operation::valid::ConsistentAreaTester::~ConsistentAreaTester </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><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="a0ae7663edf982238c84836029a858a8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; geos::operation::valid::ConsistentAreaTester::getInvalidPoint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the intersection point, or <code>null</code> if none was found </dd></dl>
</div>
</div>
<a class="anchor" id="a380c67355ef80015402cc5ff0770be32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::valid::ConsistentAreaTester::hasDuplicateRings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for two duplicate rings in an area. Duplicate rings are rings that are topologically equal (that is, which have the same sequence of points up to point order). If the area is topologically consistent (determined by calling the <code>isNodeConsistentArea</code>, duplicate rings can be found by checking for EdgeBundles which contain more than one <a class="el" href="classgeos_1_1geomgraph_1_1EdgeEnd.html" title="Models the end of an edge incident on a node. ">geomgraph::EdgeEnd</a>. (This is because topologically consistent areas cannot have two rings sharing the same line segment, unless the rings are equal). The start point of one of the equal rings will be placed in invalidPoint.</p>
<dl class="section return"><dt>Returns</dt><dd>true if this area Geometry is topologically consistent but has two duplicate rings </dd></dl>
</div>
</div>
<a class="anchor" id="a4772f1fd7dd9c24aa2d5ed38f107bcf8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::valid::ConsistentAreaTester::isNodeConsistentArea </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check all nodes to see if their labels are consistent with area topology. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if this area has a consistent node labelling </dd></dl>
</div>
</div>
<a class="anchor" id="ac04bab075a69fe57fc27470d1619b510"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::valid::ConsistentAreaTester::isNodeEdgeAreaLabelsConsistent </td>
<td>(</td>
<td class="paramname"></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">
<p>Check all nodes to see if their labels are consistent. If any are not, return false </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9e9ddbf9d001b6e8e1f6e96f3935b682"></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_1geomgraph_1_1GeometryGraph.html">geomgraph::GeometryGraph</a>* geos::operation::valid::ConsistentAreaTester::geomGraph</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>Not owned. </p>
<p>Definition at line <a class="el" href="ConsistentAreaTester_8h_source.html#l00075">75</a> of file <a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5f4aa5e869917969262717dc628e4eb3"></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_1geom_1_1Coordinate.html">geom::Coordinate</a> geos::operation::valid::ConsistentAreaTester::invalidPoint</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>the intersection point found (if any) </p>
<p>Definition at line <a class="el" href="ConsistentAreaTester_8h_source.html#l00080">80</a> of file <a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>.</p>
</div>
</div>
<a class="anchor" id="a832d443a49a84fd4f3349c9ef6cb82e6"></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_1LineIntersector.html">algorithm::LineIntersector</a> geos::operation::valid::ConsistentAreaTester::li</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="ConsistentAreaTester_8h_source.html#l00072">72</a> of file <a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac425d9f02b9b30412b72514cbc5ceba7"></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_1operation_1_1relate_1_1RelateNodeGraph.html">relate::RelateNodeGraph</a> geos::operation::valid::ConsistentAreaTester::nodeGraph</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="ConsistentAreaTester_8h_source.html#l00077">77</a> of file <a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ConsistentAreaTester_8h_source.html">ConsistentAreaTester.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>