geos_390_docs/classgeos_1_1precision_1_1M...

254 lines
12 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::precision::MinimumClearance 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_1precision.html">precision</a></li><li class="navelem"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html">MinimumClearance</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_1precision_1_1MinimumClearance-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::precision::MinimumClearance Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Computes the Minimum Clearance of a Geometry.
<a href="classgeos_1_1precision_1_1MinimumClearance.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::precision::MinimumClearance:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1precision_1_1MinimumClearance__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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab11d7e3eeb56770d13e5ff79e8abd9a6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#ab11d7e3eeb56770d13e5ff79e8abd9a6">MinimumClearance</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *g)</td></tr>
<tr class="separator:ab11d7e3eeb56770d13e5ff79e8abd9a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8be12962a236e7bbffd83ae38a102f7a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a8be12962a236e7bbffd83ae38a102f7a">getDistance</a> ()</td></tr>
<tr class="separator:a8be12962a236e7bbffd83ae38a102f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a25fdf051cf92b59a6412fa2fa068e5"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a8a25fdf051cf92b59a6412fa2fa068e5">getLine</a> ()</td></tr>
<tr class="separator:a8a25fdf051cf92b59a6412fa2fa068e5"><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:a28433359b56a42bb18a546ff809ae2c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a28433359b56a42bb18a546ff809ae2c4">compute</a> ()</td></tr>
<tr class="separator:a28433359b56a42bb18a546ff809ae2c4"><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:a98b259c53da23160b122f5fdc3c992d3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a98b259c53da23160b122f5fdc3c992d3">inputGeom</a></td></tr>
<tr class="separator:a98b259c53da23160b122f5fdc3c992d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f64b8bca529a9756f9db503ddcc63f5"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a0f64b8bca529a9756f9db503ddcc63f5">minClearance</a></td></tr>
<tr class="separator:a0f64b8bca529a9756f9db503ddcc63f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3960f98365bc795edc2b260bbd5fcc1b"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1MinimumClearance.html#a3960f98365bc795edc2b260bbd5fcc1b">minClearancePts</a></td></tr>
<tr class="separator:a3960f98365bc795edc2b260bbd5fcc1b"><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>Computes the Minimum Clearance of a Geometry. </p>
<p>Definition at line <a class="el" href="MinimumClearance_8h_source.html#l00030">30</a> of file <a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab11d7e3eeb56770d13e5ff79e8abd9a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::precision::MinimumClearance::MinimumClearance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a28433359b56a42bb18a546ff809ae2c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::precision::MinimumClearance::compute </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="a8be12962a236e7bbffd83ae38a102f7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double geos::precision::MinimumClearance::getDistance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the Minimum Clearance distance.</p>
<dl class="section return"><dt>Returns</dt><dd>the value of the minimum clearance distance or <code>DBL_MAX</code> if no Minimum Clearance distance exists </dd></dl>
</div>
</div>
<a class="anchor" id="a8a25fdf051cf92b59a6412fa2fa068e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>&gt; geos::precision::MinimumClearance::getLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a LineString containing two points which are at the Minimum Clearance distance.</p>
<dl class="section return"><dt>Returns</dt><dd>the value of the minimum clearance distance or <code>LINESTRING EMPTY</code> if no Minimum Clearance distance exists </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a98b259c53da23160b122f5fdc3c992d3"></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>* geos::precision::MinimumClearance::inputGeom</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="MinimumClearance_8h_source.html#l00032">32</a> of file <a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0f64b8bca529a9756f9db503ddcc63f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double geos::precision::MinimumClearance::minClearance</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="MinimumClearance_8h_source.html#l00033">33</a> of file <a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3960f98365bc795edc2b260bbd5fcc1b"></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_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>&gt; geos::precision::MinimumClearance::minClearancePts</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="MinimumClearance_8h_source.html#l00034">34</a> of file <a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MinimumClearance_8h_source.html">MinimumClearance.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>