geos_390_docs/classgeos_1_1linearref_1_1L...

220 lines
13 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::LocationIndexOfLine 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_1LocationIndexOfLine.html">LocationIndexOfLine</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-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1linearref_1_1LocationIndexOfLine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::linearref::LocationIndexOfLine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Determines the location of a subline along a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>.
<a href="classgeos_1_1linearref_1_1LocationIndexOfLine.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="LocationIndexOfLine_8h_source.html">LocationIndexOfLine.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::linearref::LocationIndexOfLine:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1linearref_1_1LocationIndexOfLine__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:a33f0171b5070c659a545538bb0ad5a38"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfLine.html#a33f0171b5070c659a545538bb0ad5a38">LocationIndexOfLine</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfLine.html#a3d09bb8b44c8c23b2ca77e5745366548">linearGeom</a>)</td></tr>
<tr class="separator:a33f0171b5070c659a545538bb0ad5a38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a96f2eca6cdc376b17069cb6f0258f8"><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_1LocationIndexOfLine.html#a4a96f2eca6cdc376b17069cb6f0258f8">indicesOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *subLine) const </td></tr>
<tr class="memdesc:a4a96f2eca6cdc376b17069cb6f0258f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Caller must take of releasing with delete[]. <a href="#a4a96f2eca6cdc376b17069cb6f0258f8">More...</a><br /></td></tr>
<tr class="separator:a4a96f2eca6cdc376b17069cb6f0258f8"><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:a38bd354832f0cc07c37e805526b11384"><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_1LocationIndexOfLine.html#a38bd354832f0cc07c37e805526b11384">indicesOf</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LocationIndexOfLine.html#a3d09bb8b44c8c23b2ca77e5745366548">linearGeom</a>, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *subLine)</td></tr>
<tr class="memdesc:a38bd354832f0cc07c37e805526b11384"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the location of a subline along a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. <a href="#a38bd354832f0cc07c37e805526b11384">More...</a><br /></td></tr>
<tr class="separator:a38bd354832f0cc07c37e805526b11384"><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:a3d09bb8b44c8c23b2ca77e5745366548"><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_1LocationIndexOfLine.html#a3d09bb8b44c8c23b2ca77e5745366548">linearGeom</a></td></tr>
<tr class="separator:a3d09bb8b44c8c23b2ca77e5745366548"><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>Determines the location of a subline along a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. </p>
<p>The location is reported as a pair of <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>s.</p>
<dl class="section note"><dt>Note</dt><dd>Currently this algorithm is not guaranteed to return the correct substring in some situations where an endpoint of the test line occurs more than once in the input line. (However, the common case of a ring is always handled correctly). </dd></dl>
<p>Definition at line <a class="el" href="LocationIndexOfLine_8h_source.html#l00040">40</a> of file <a class="el" href="LocationIndexOfLine_8h_source.html">LocationIndexOfLine.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a33f0171b5070c659a545538bb0ad5a38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LocationIndexOfLine::LocationIndexOfLine </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="a38bd354832f0cc07c37e805526b11384"></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::LocationIndexOfLine::indicesOf </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_1Geometry.html">geom::Geometry</a> *&#160;</td>
<td class="paramname"><em>subLine</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>Determines the location of a subline along a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>. </p>
<p>The location is reported as a pair of <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocations</a>.</p>
<dl class="section note"><dt>Note</dt><dd>Currently this algorithm is not guaranteed to return the correct substring in some situations where an endpoint of the test line occurs more than once in the input line. (However, the common case of a ring is always handled correctly).</dd>
<dd>
Caller must take of releasing with delete[] </dd></dl>
<p>Referenced by <a class="el" href="LocationIndexedLine_8h_source.html#l00199">geos::linearref::LocationIndexedLine::indicesOf()</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_1LocationIndexOfLine_a38bd354832f0cc07c37e805526b11384_icgraph.svg" width="408" 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="a4a96f2eca6cdc376b17069cb6f0258f8"></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::LocationIndexOfLine::indicesOf </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>subLine</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Caller must take of releasing with delete[]. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a3d09bb8b44c8c23b2ca77e5745366548"></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::LocationIndexOfLine::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>MD - this algorithm has been extracted into a class because it is intended to validate that the subline truly is a subline, and also to use the internal vertex information to unambiguously locate the subline. </p>
<p>Definition at line <a class="el" href="LocationIndexOfLine_8h_source.html#l00047">47</a> of file <a class="el" href="LocationIndexOfLine_8h_source.html">LocationIndexOfLine.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LocationIndexOfLine_8h_source.html">LocationIndexOfLine.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>