geos_390_docs/classgeos_1_1noding_1_1Fast...

425 lines
22 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::noding::FastNodingValidator 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_1noding.html">noding</a></li><li class="navelem"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</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_1noding_1_1FastNodingValidator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::noding::FastNodingValidator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Validates that a collection of <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a>s is correctly noded.
<a href="classgeos_1_1noding_1_1FastNodingValidator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::noding::FastNodingValidator:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1FastNodingValidator__coll__graph.svg" width="512" height="255"><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:a8c81ddd9ca5a89e4c2652422559b5e3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a8c81ddd9ca5a89e4c2652422559b5e3a">FastNodingValidator</a> (std::vector&lt; <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">noding::SegmentString</a> * &gt; &amp;newSegStrings)</td></tr>
<tr class="separator:a8c81ddd9ca5a89e4c2652422559b5e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad541ae8ff8cf433d24e3ec4b22fa5cd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#aad541ae8ff8cf433d24e3ec4b22fa5cd">isValid</a> ()</td></tr>
<tr class="memdesc:aad541ae8ff8cf433d24e3ec4b22fa5cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for an intersection and reports if one is found. <a href="#aad541ae8ff8cf433d24e3ec4b22fa5cd">More...</a><br /></td></tr>
<tr class="separator:aad541ae8ff8cf433d24e3ec4b22fa5cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af39a7aecf9f86bf506c1706d425317b3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#af39a7aecf9f86bf506c1706d425317b3">getErrorMessage</a> () const </td></tr>
<tr class="memdesc:af39a7aecf9f86bf506c1706d425317b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an error message indicating the segments containing the intersection. <a href="#af39a7aecf9f86bf506c1706d425317b3">More...</a><br /></td></tr>
<tr class="separator:af39a7aecf9f86bf506c1706d425317b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a214f1ee69eba7f22ea1125c678cd08aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a214f1ee69eba7f22ea1125c678cd08aa">checkValid</a> ()</td></tr>
<tr class="memdesc:a214f1ee69eba7f22ea1125c678cd08aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for an intersection and throws a TopologyException if one is found. <a href="#a214f1ee69eba7f22ea1125c678cd08aa">More...</a><br /></td></tr>
<tr class="separator:a214f1ee69eba7f22ea1125c678cd08aa"><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:a2a6a61e4844c463142adb23e7f2f4f10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a2a6a61e4844c463142adb23e7f2f4f10">execute</a> ()</td></tr>
<tr class="separator:a2a6a61e4844c463142adb23e7f2f4f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6274fffbb40e140ccad8fb9203338df9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a6274fffbb40e140ccad8fb9203338df9">checkInteriorIntersections</a> ()</td></tr>
<tr class="separator:a6274fffbb40e140ccad8fb9203338df9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb74644d96dd9c68a0f9802611af0696"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#adb74644d96dd9c68a0f9802611af0696">FastNodingValidator</a> (const <a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</a> &amp;other)=delete</td></tr>
<tr class="separator:adb74644d96dd9c68a0f9802611af0696"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0f0a3ff8be807dc19dc543597082d71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#ac0f0a3ff8be807dc19dc543597082d71">operator=</a> (const <a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</a> &amp;rhs)=delete</td></tr>
<tr class="separator:ac0f0a3ff8be807dc19dc543597082d71"><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:af47570d55672b8814b343a1d5bdad424"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1algorithm_1_1LineIntersector.html">geos::algorithm::LineIntersector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#af47570d55672b8814b343a1d5bdad424">li</a></td></tr>
<tr class="separator:af47570d55672b8814b343a1d5bdad424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e8b0039c13fdad4e328acc4bc082d81"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">noding::SegmentString</a> * &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a4e8b0039c13fdad4e328acc4bc082d81">segStrings</a></td></tr>
<tr class="separator:a4e8b0039c13fdad4e328acc4bc082d81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c979b0c25e6134e72dd99e893401ab"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1noding_1_1NodingIntersectionFinder.html">NodingIntersectionFinder</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#a96c979b0c25e6134e72dd99e893401ab">segInt</a></td></tr>
<tr class="separator:a96c979b0c25e6134e72dd99e893401ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb2b1ba16f0a6287c59f23e06d74a1fb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#adb2b1ba16f0a6287c59f23e06d74a1fb">isValidVar</a></td></tr>
<tr class="separator:adb2b1ba16f0a6287c59f23e06d74a1fb"><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>Validates that a collection of <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a>s is correctly noded. </p>
<p>Indexing is used to improve performance. By default validation stops after a single non-noded intersection is detected. Alternatively, it can be requested to detect all intersections by using <code>setFindAllIntersections(boolean)</code>.</p>
<p>The validator does not check for topology collapse situations (e.g. where two segment strings are fully co-incident).</p>
<p>The validator checks for the following situations which indicated incorrect noding:</p>
<ul>
<li>Proper intersections between segments (i.e. the intersection is interior to both segments)</li>
<li>Intersections at an interior vertex (i.e. with an endpoint or another interior vertex)</li>
</ul>
<p>The client may either test the <a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html#aad541ae8ff8cf433d24e3ec4b22fa5cd">isValid()</a> condition, or request that a suitable <a class="el" href="classgeos_1_1util_1_1TopologyException.html">TopologyException</a> be thrown. </p>
<p>Definition at line <a class="el" href="FastNodingValidator_8h_source.html#l00060">60</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8c81ddd9ca5a89e4c2652422559b5e3a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::noding::FastNodingValidator::FastNodingValidator </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">noding::SegmentString</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>newSegStrings</em></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="FastNodingValidator_8h_source.html#l00064">64</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="adb74644d96dd9c68a0f9802611af0696"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::noding::FastNodingValidator::FastNodingValidator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6274fffbb40e140ccad8fb9203338df9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::noding::FastNodingValidator::checkInteriorIntersections </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">
</div>
</div>
<a class="anchor" id="a214f1ee69eba7f22ea1125c678cd08aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::noding::FastNodingValidator::checkValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for an intersection and throws a TopologyException if one is found. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">TopologyException</td><td>if an intersection is found </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="EdgeNodingValidator_8h_source.html#l00104">geos::geomgraph::EdgeNodingValidator::checkValid()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1FastNodingValidator_a214f1ee69eba7f22ea1125c678cd08aa_icgraph.svg" width="468" height="55"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a2a6a61e4844c463142adb23e7f2f4f10"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::noding::FastNodingValidator::execute </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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="FastNodingValidator_8h_source.html#l00113">113</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="af39a7aecf9f86bf506c1706d425317b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string geos::noding::FastNodingValidator::getErrorMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an error message indicating the segments containing the intersection. </p>
<dl class="section return"><dt>Returns</dt><dd>an error message documenting the intersection location </dd></dl>
</div>
</div>
<a class="anchor" id="aad541ae8ff8cf433d24e3ec4b22fa5cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::FastNodingValidator::isValid </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for an intersection and reports if one is found. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the arrangement contains an interior intersection </dd></dl>
<p>Definition at line <a class="el" href="FastNodingValidator_8h_source.html#l00080">80</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac0f0a3ff8be807dc19dc543597082d71"></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_1noding_1_1FastNodingValidator.html">FastNodingValidator</a>&amp; geos::noding::FastNodingValidator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1FastNodingValidator.html">FastNodingValidator</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="adb2b1ba16f0a6287c59f23e06d74a1fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::FastNodingValidator::isValidVar</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="FastNodingValidator_8h_source.html#l00110">110</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="af47570d55672b8814b343a1d5bdad424"></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">geos::algorithm::LineIntersector</a> geos::noding::FastNodingValidator::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="FastNodingValidator_8h_source.html#l00104">104</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a96c979b0c25e6134e72dd99e893401ab"></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_1noding_1_1NodingIntersectionFinder.html">NodingIntersectionFinder</a>&gt; geos::noding::FastNodingValidator::segInt</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="FastNodingValidator_8h_source.html#l00108">108</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4e8b0039c13fdad4e328acc4bc082d81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classgeos_1_1noding_1_1SegmentString.html">noding::SegmentString</a>*&gt;&amp; geos::noding::FastNodingValidator::segStrings</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="FastNodingValidator_8h_source.html#l00106">106</a> of file <a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FastNodingValidator_8h_source.html">FastNodingValidator.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>