geos_390_docs/classgeos_1_1linearref_1_1E...

368 lines
20 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::ExtractLineByLocation 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_1ExtractLineByLocation.html">ExtractLineByLocation</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_1ExtractLineByLocation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::linearref::ExtractLineByLocation Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Extracts the subline of a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> between two <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>s on the line.
<a href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ExtractLineByLocation_8h_source.html">ExtractLineByLocation.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::linearref::ExtractLineByLocation:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1linearref_1_1ExtractLineByLocation__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:aac8678e1088b3d8878d3d660bfb699af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#aac8678e1088b3d8878d3d660bfb699af">ExtractLineByLocation</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a0b76a4f4a1a44844adf96d8d030cf9b1">line</a>)</td></tr>
<tr class="separator:aac8678e1088b3d8878d3d660bfb699af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4da808042059a648ed1d0062b966c2c2"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a4da808042059a648ed1d0062b966c2c2">extract</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;start, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;end)</td></tr>
<tr class="memdesc:a4da808042059a648ed1d0062b966c2c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts a subline of the input. <a href="#a4da808042059a648ed1d0062b966c2c2">More...</a><br /></td></tr>
<tr class="separator:a4da808042059a648ed1d0062b966c2c2"><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:a3b7be088b267db30899dbdf4696407ca"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a3b7be088b267db30899dbdf4696407ca">extract</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a0b76a4f4a1a44844adf96d8d030cf9b1">line</a>, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;start, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;end)</td></tr>
<tr class="memdesc:a3b7be088b267db30899dbdf4696407ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the subline of a <a class="el" href="classgeos_1_1geom_1_1LineString.html">LineString</a> between two <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>s on the line. <a href="#a3b7be088b267db30899dbdf4696407ca">More...</a><br /></td></tr>
<tr class="separator:a3b7be088b267db30899dbdf4696407ca"><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:a3f0f94d9a0a6cfa80f21f979ba43bfd6"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a3f0f94d9a0a6cfa80f21f979ba43bfd6">reverse</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *linear)</td></tr>
<tr class="separator:a3f0f94d9a0a6cfa80f21f979ba43bfd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8fa0a5a7f584dcd687b4515a9807d59"><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_1linearref_1_1ExtractLineByLocation.html#ad8fa0a5a7f584dcd687b4515a9807d59">computeLine</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;start, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;end)</td></tr>
<tr class="separator:ad8fa0a5a7f584dcd687b4515a9807d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b06c8f58cea90985b61e68e4f851fa0"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1ExtractLineByLocation.html#a5b06c8f58cea90985b61e68e4f851fa0">computeLinear</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;start, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;end)</td></tr>
<tr class="separator:a5b06c8f58cea90985b61e68e4f851fa0"><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:a0b76a4f4a1a44844adf96d8d030cf9b1"><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_1ExtractLineByLocation.html#a0b76a4f4a1a44844adf96d8d030cf9b1">line</a></td></tr>
<tr class="separator:a0b76a4f4a1a44844adf96d8d030cf9b1"><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>Extracts the subline of a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> between two <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>s on the line. </p>
<p>Definition at line <a class="el" href="ExtractLineByLocation_8h_source.html#l00034">34</a> of file <a class="el" href="ExtractLineByLocation_8h_source.html">ExtractLineByLocation.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aac8678e1088b3d8878d3d660bfb699af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::ExtractLineByLocation::ExtractLineByLocation </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>line</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="ad8fa0a5a7f584dcd687b4515a9807d59"></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_1LineString.html">geom::LineString</a>&gt; geos::linearref::ExtractLineByLocation::computeLine </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;&#160;</td>
<td class="paramname"><em>start</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> &amp;&#160;</td>
<td class="paramname"><em>end</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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assumes input is valid (e.g. start &lt;= end)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td></td></tr>
<tr><td class="paramname">end</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a linear geometry </dd></dl>
</div>
</div>
<a class="anchor" id="a5b06c8f58cea90985b61e68e4f851fa0"></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_1Geometry.html">geom::Geometry</a>&gt; geos::linearref::ExtractLineByLocation::computeLinear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;&#160;</td>
<td class="paramname"><em>start</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> &amp;&#160;</td>
<td class="paramname"><em>end</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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assumes input is valid (e.g. start &lt;= end)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td></td></tr>
<tr><td class="paramname">end</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a linear geometry </dd></dl>
</div>
</div>
<a class="anchor" id="a3b7be088b267db30899dbdf4696407ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&gt; geos::linearref::ExtractLineByLocation::extract </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>line</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> &amp;&#160;</td>
<td class="paramname"><em>start</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> &amp;&#160;</td>
<td class="paramname"><em>end</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>Computes the subline of a <a class="el" href="classgeos_1_1geom_1_1LineString.html">LineString</a> between two <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a>s on the line. </p>
<p>If the start location is after the end location, the computed geometry is reversed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>the line to use as the baseline </td></tr>
<tr><td class="paramname">start</td><td>the start location </td></tr>
<tr><td class="paramname">end</td><td>the end location </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the extracted subline </dd></dl>
<p>Referenced by <a class="el" href="LocationIndexedLine_8h_source.html#l00128">geos::linearref::LocationIndexedLine::extractLine()</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_1ExtractLineByLocation_a3b7be088b267db30899dbdf4696407ca_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="a4da808042059a648ed1d0062b966c2c2"></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_1Geometry.html">geom::Geometry</a>&gt; geos::linearref::ExtractLineByLocation::extract </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;&#160;</td>
<td class="paramname"><em>start</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> &amp;&#160;</td>
<td class="paramname"><em>end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a subline of the input. </p>
<p>If <code>end &lt; start</code> the linear geometry computed will be reversed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>the start location </td></tr>
<tr><td class="paramname">end</td><td>the end location </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a linear geometry </dd></dl>
</div>
</div>
<a class="anchor" id="a3f0f94d9a0a6cfa80f21f979ba43bfd6"></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_1Geometry.html">geom::Geometry</a>&gt; geos::linearref::ExtractLineByLocation::reverse </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>linear</em></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>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0b76a4f4a1a44844adf96d8d030cf9b1"></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::ExtractLineByLocation::line</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="ExtractLineByLocation_8h_source.html#l00037">37</a> of file <a class="el" href="ExtractLineByLocation_8h_source.html">ExtractLineByLocation.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ExtractLineByLocation_8h_source.html">ExtractLineByLocation.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>