370 lines
18 KiB
HTML
370 lines
18 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::linearref::LengthIndexOfPoint 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
|
|
 <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 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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_1linearref.html">linearref</a></li><li class="navelem"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html">LengthIndexOfPoint</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classgeos_1_1linearref_1_1LengthIndexOfPoint-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">geos::linearref::LengthIndexOfPoint Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Computes the length index of the point on a linear Geometry nearest a given Coordinate.
|
|
<a href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="LengthIndexOfPoint_8h_source.html">LengthIndexOfPoint.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for geos::linearref::LengthIndexOfPoint:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1linearref_1_1LengthIndexOfPoint__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:a670a3a9971e7cf07e7e2b845839dbb51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#a670a3a9971e7cf07e7e2b845839dbb51">LengthIndexOfPoint</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#afad851d614d2373834147a3ab5af0924">linearGeom</a>)</td></tr>
|
|
<tr class="separator:a670a3a9971e7cf07e7e2b845839dbb51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a929783999f98fadcea721aa631963c"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#a9a929783999f98fadcea721aa631963c">indexOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt) const </td></tr>
|
|
<tr class="separator:a9a929783999f98fadcea721aa631963c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ec4f3410a14bdcd4a63aa1a6e9faaea"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#a1ec4f3410a14bdcd4a63aa1a6e9faaea">indexOfAfter</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt, double minIndex) const </td></tr>
|
|
<tr class="memdesc:a1ec4f3410a14bdcd4a63aa1a6e9faaea"><td class="mdescLeft"> </td><td class="mdescRight">Finds the nearest index along the linear Geometry to a given Coordinate after the specified minimum index. <a href="#a1ec4f3410a14bdcd4a63aa1a6e9faaea">More...</a><br /></td></tr>
|
|
<tr class="separator:a1ec4f3410a14bdcd4a63aa1a6e9faaea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a94774c5c896757cddd71d61fab9104f6"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#a94774c5c896757cddd71d61fab9104f6">indexOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#afad851d614d2373834147a3ab5af0924">linearGeom</a>, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt)</td></tr>
|
|
<tr class="separator:a94774c5c896757cddd71d61fab9104f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd7003447c66a570a4a8511993c86517"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#afd7003447c66a570a4a8511993c86517">indexOfAfter</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#afad851d614d2373834147a3ab5af0924">linearGeom</a>, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt, double minIndex)</td></tr>
|
|
<tr class="separator:afd7003447c66a570a4a8511993c86517"><td class="memSeparator" colspan="2"> </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:aafed04611bb821264322e368dd729b0d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#aafed04611bb821264322e368dd729b0d">indexOfFromStart</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt, const double minIndex) const </td></tr>
|
|
<tr class="separator:aafed04611bb821264322e368dd729b0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99af2cf653cec40fae96059c3f0de081"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#a99af2cf653cec40fae96059c3f0de081">segmentNearestMeasure</a> (const <a class="el" href="classgeos_1_1geom_1_1LineSegment.html">geom::LineSegment</a> *seg, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &inputPt, double segmentStartMeasure) const </td></tr>
|
|
<tr class="separator:a99af2cf653cec40fae96059c3f0de081"><td class="memSeparator" colspan="2"> </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:afad851d614d2373834147a3ab5af0924"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LengthIndexOfPoint.html#afad851d614d2373834147a3ab5af0924">linearGeom</a></td></tr>
|
|
<tr class="separator:afad851d614d2373834147a3ab5af0924"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Computes the length index of the point on a linear Geometry nearest a given Coordinate. </p>
|
|
<p>The nearest point is not necessarily unique; this class always computes the nearest point closest to the start of the geometry. </p>
|
|
|
|
<p>Definition at line <a class="el" href="LengthIndexOfPoint_8h_source.html#l00043">43</a> of file <a class="el" href="LengthIndexOfPoint_8h_source.html">LengthIndexOfPoint.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a670a3a9971e7cf07e7e2b845839dbb51"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">geos::linearref::LengthIndexOfPoint::LengthIndexOfPoint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td>
|
|
<td class="paramname"><em>linearGeom</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="a94774c5c896757cddd71d61fab9104f6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static double geos::linearref::LengthIndexOfPoint::indexOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td>
|
|
<td class="paramname"><em>linearGeom</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9a929783999f98fadcea721aa631963c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double geos::linearref::LengthIndexOfPoint::indexOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Find the nearest location along a linear Geometry to a given point.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inputPt</td><td>the coordinate to locate </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the location of the nearest point </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afd7003447c66a570a4a8511993c86517"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static double geos::linearref::LengthIndexOfPoint::indexOfAfter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td>
|
|
<td class="paramname"><em>linearGeom</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>minIndex</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1ec4f3410a14bdcd4a63aa1a6e9faaea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double geos::linearref::LengthIndexOfPoint::indexOfAfter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>minIndex</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finds the nearest index along the linear Geometry to a given Coordinate after the specified minimum index. </p>
|
|
<p>If possible the location returned will be strictly greater than the <code>minLocation</code>. If this is not possible, the value returned will equal <code>minLocation</code>. (An example where this is not possible is when minLocation = [end of line] ).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inputPt</td><td>the coordinate to locate </td></tr>
|
|
<tr><td class="paramname">minIndex</td><td>the minimum location for the point location </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the location of the nearest point </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aafed04611bb821264322e368dd729b0d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double geos::linearref::LengthIndexOfPoint::indexOfFromStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const double </td>
|
|
<td class="paramname"><em>minIndex</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</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="a99af2cf653cec40fae96059c3f0de081"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double geos::linearref::LengthIndexOfPoint::segmentNearestMeasure </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1LineSegment.html">geom::LineSegment</a> * </td>
|
|
<td class="paramname"><em>seg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>inputPt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>segmentStartMeasure</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</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>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="afad851d614d2373834147a3ab5af0924"></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::linearref::LengthIndexOfPoint::linearGeom</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="LengthIndexOfPoint_8h_source.html#l00046">46</a> of file <a class="el" href="LengthIndexOfPoint_8h_source.html">LengthIndexOfPoint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="LengthIndexOfPoint_8h_source.html">LengthIndexOfPoint.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|