geos_390_docs/classgeos_1_1linearref_1_1L...

350 lines
21 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::LocationIndexOfPoint 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_1linearref.html">linearref</a></li><li class="navelem"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html">LocationIndexOfPoint</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static 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_1linearref_1_1LocationIndexOfPoint-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::linearref::LocationIndexOfPoint Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Computes the <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> of the point on a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> nearest a given <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a>.
<a href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="LocationIndexOfPoint_8h_source.html">LocationIndexOfPoint.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::linearref::LocationIndexOfPoint:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1linearref_1_1LocationIndexOfPoint__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:a399191cfe2192743f45f282ea91d71bf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a399191cfe2192743f45f282ea91d71bf">LocationIndexOfPoint</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a4bc1a234c3fa1c3f998a51b4b2231f6b">linearGeom</a>)</td></tr>
<tr class="separator:a399191cfe2192743f45f282ea91d71bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73594c44b6d65205168467c1635a6d23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a73594c44b6d65205168467c1635a6d23">indexOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;inputPt) const </td></tr>
<tr class="memdesc:a73594c44b6d65205168467c1635a6d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the nearest location along a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> to a given point. <a href="#a73594c44b6d65205168467c1635a6d23">More...</a><br /></td></tr>
<tr class="separator:a73594c44b6d65205168467c1635a6d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47a36db81f65290d29375d9c3a4a9c3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a47a36db81f65290d29375d9c3a4a9c3d">indexOfAfter</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;inputPt, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *minIndex) const </td></tr>
<tr class="memdesc:a47a36db81f65290d29375d9c3a4a9c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the nearest <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> along the linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> to a given <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> after the specified minimum <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a>. <a href="#a47a36db81f65290d29375d9c3a4a9c3d">More...</a><br /></td></tr>
<tr class="separator:a47a36db81f65290d29375d9c3a4a9c3d"><td class="memSeparator" colspan="2">&#160;</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:a02a74fcef91895e29a08ba509950e95f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a02a74fcef91895e29a08ba509950e95f">indexOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a4bc1a234c3fa1c3f998a51b4b2231f6b">linearGeom</a>, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;inputPt)</td></tr>
<tr class="separator:a02a74fcef91895e29a08ba509950e95f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6a5f8fbb298ead569b3befa6d99c159"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#ad6a5f8fbb298ead569b3befa6d99c159">indexOfAfter</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a4bc1a234c3fa1c3f998a51b4b2231f6b">linearGeom</a>, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;inputPt, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *minIndex)</td></tr>
<tr class="separator:ad6a5f8fbb298ead569b3befa6d99c159"><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:a644162162cf980aa1326ef3d97c8c847"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfPoint.html#a644162162cf980aa1326ef3d97c8c847">indexOfFromStart</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;inputPt, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *minIndex) const </td></tr>
<tr class="separator:a644162162cf980aa1326ef3d97c8c847"><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:a4bc1a234c3fa1c3f998a51b4b2231f6b"><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_1linearref_1_1LocationIndexOfPoint.html#a4bc1a234c3fa1c3f998a51b4b2231f6b">linearGeom</a></td></tr>
<tr class="separator:a4bc1a234c3fa1c3f998a51b4b2231f6b"><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 <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> of the point on a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> nearest a given <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a>. </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="LocationIndexOfPoint_8h_source.html#l00038">38</a> of file <a class="el" href="LocationIndexOfPoint_8h_source.html">LocationIndexOfPoint.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a399191cfe2192743f45f282ea91d71bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LocationIndexOfPoint::LocationIndexOfPoint </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>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="a02a74fcef91895e29a08ba509950e95f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> geos::linearref::LocationIndexOfPoint::indexOf </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>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> &amp;&#160;</td>
<td class="paramname"><em>inputPt</em>&#160;</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">
<p>Referenced by <a class="el" href="LocationIndexedLine_8h_source.html#l00151">geos::linearref::LocationIndexedLine::indexOf()</a>, and <a class="el" href="LocationIndexedLine_8h_source.html#l00217">geos::linearref::LocationIndexedLine::project()</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_1linearref_1_1LocationIndexOfPoint_a02a74fcef91895e29a08ba509950e95f_icgraph.svg" width="408" height="123"><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="a73594c44b6d65205168467c1635a6d23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> geos::linearref::LocationIndexOfPoint::indexOf </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</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 <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> 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="ad6a5f8fbb298ead569b3befa6d99c159"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> geos::linearref::LocationIndexOfPoint::indexOfAfter </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>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> &amp;&#160;</td>
<td class="paramname"><em>inputPt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *&#160;</td>
<td class="paramname"><em>minIndex</em>&#160;</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">
<p>Referenced by <a class="el" href="LocationIndexedLine_8h_source.html#l00181">geos::linearref::LocationIndexedLine::indexOfAfter()</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_1linearref_1_1LocationIndexOfPoint_ad6a5f8fbb298ead569b3befa6d99c159_icgraph.svg" width="440" 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="a47a36db81f65290d29375d9c3a4a9c3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> geos::linearref::LocationIndexOfPoint::indexOfAfter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>inputPt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *&#160;</td>
<td class="paramname"><em>minIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the nearest <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> along the linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> to a given <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> after the specified minimum <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a>. </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 <code>minLocation = [end of line]</code>).</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="a644162162cf980aa1326ef3d97c8c847"></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_1linearref_1_1LinearLocation.html">LinearLocation</a> geos::linearref::LocationIndexOfPoint::indexOfFromStart </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>inputPt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> *&#160;</td>
<td class="paramname"><em>minIndex</em>&#160;</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="a4bc1a234c3fa1c3f998a51b4b2231f6b"></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::LocationIndexOfPoint::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="LocationIndexOfPoint_8h_source.html#l00041">41</a> of file <a class="el" href="LocationIndexOfPoint_8h_source.html">LocationIndexOfPoint.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LocationIndexOfPoint_8h_source.html">LocationIndexOfPoint.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>