darkblueb
/
geos_390_docs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
geos_390_docs/LinearLocation_8h_source.html

94 lines
32 KiB
HTML
Raw Permalink Normal View History

init
2020-12-23 18:34:09 -08:00
<!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: LinearLocation.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0bc14b2fb119a11b6a0f32f4d350db61.html">geos</a></li><li class="navelem"><a class="el" href="dir_557b1f226c2ae37e53b1ff2907cf4831.html">linearref</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LinearLocation.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="LinearLocation_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**********************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * GEOS - Geometry Engine Open Source</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * http://geos.osgeo.org</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Copyright (C) 2011 Sandro Santilli &lt;strk@kbt.io&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Copyright (C) 2005-2006 Refractions Research Inc.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * Copyright (C) 2001-2002 Vivid Solutions Inc.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * by the Free Software Foundation.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * See the COPYING file for more information.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> **********************************************************************</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * Last port: linearref/LinearLocation.java r463</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> **********************************************************************/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef GEOS_LINEARREF_LINEARLOCATION_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define GEOS_LINEARREF_LINEARLOCATION_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span> <span class="comment">// for std::unique_ptr</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Coordinate_8h.html">geos/geom/Coordinate.h</a>&gt;</span></div><div class="line"><a name="l00028"></a><spa
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a3b269d2f5e864d6b3c3a5f3258d001fc"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a3b269d2f5e864d6b3c3a5f3258d001fc">geos::linearref::LinearLocation::componentIndex</a></div><div class="ttdeci">size_t componentIndex</div><div class="ttdef"><b>Definition:</b> <a href="LinearLocation_8h_source.html#l00046">LinearLocation.h:46</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Coordinate_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Coordinate.html">geos::geom::Coordinate</a></div><div class="ttdoc">Coordinate is the lightweight class used to store coordinates. </div><div class="ttdef"><b>Definition:</b> <a href="Coordinate_8h_source.html#l00060">Coordinate.h:60</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_aa8492cc339a966a44c2db8a0446110fb"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#aa8492cc339a966a44c2db8a0446110fb">geos::linearref::LinearLocation::isVertex</a></div><div class="ttdeci">bool isVertex() const </div><div class="ttdoc">Tests whether this location refers to a vertex. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ab2ecfec59697bdd38274173e5fb847e4"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ab2ecfec59697bdd38274173e5fb847e4">geos::linearref::LinearLocation::getSegmentFraction</a></div><div class="ttdeci">double getSegmentFraction() const </div><div class="ttdoc">Gets the segment fraction for this location. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a50df7142413e9e0f71c08a17e44fb53a"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a50df7142413e9e0f71c08a17e44fb53a">geos::linearref::LinearLocation::getCoordinate</a></div><div class="ttdeci">geom::Coordinate getCoordinate(const geom::Geometry *linearGeom) const </div><div class="ttdoc">Gets the Coordinate along the given linear Geometry which is referenced by this location. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ac1de5d7e436b7249e57c2227c566eafa"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ac1de5d7e436b7249e57c2227c566eafa">geos::linearref::LinearLocation::clamp</a></div><div class="ttdeci">void clamp(const geom::Geometry *linear)</div><div class="ttdoc">Ensures the indexes are valid for a given linear Geometry. </div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Geometry_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Geometry.html">geos::geom::Geometry</a></div><div class="ttdoc">Basic implementation of Geometry, constructed and destructed by GeometryFactory. </div><div class="ttdef"><b>Definition:</b> <a href="Geometry_8h_source.html#l00188">Geometry.h:188</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ad85594096af5010d17cfa365b90c5fc6"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ad85594096af5010d17cfa365b90c5fc6">geos::linearref::LinearLocation::getSegmentLength</a></div><div class="ttdeci">double getSegmentLength(const geom::Geometry *linearGeom) const </div><div class="ttdoc">Gets the length of the segment in the given Geometry containing this location. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a52969730714ff3945d04707c6d045179"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a52969730714ff3945d04707c6d045179">geos::linearref::LinearLocation::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, const LinearLocation &amp;obj)</div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a79d7e63643fc4608a15bc5217c092dc0"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a79d7e63643fc4608a15bc5217c092dc0">geos::linearref::LinearLocation::compareLocationValues</a></div><div class="ttdeci">int compareLocationValues(size_t componentIndex1, size_t segmentIndex1, double segmentFraction1) const </div><div class="ttdoc">Compares this object with the specified index values for order. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a801f6db68967f91b51aa0a426cc6b438"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a801f6db68967f91b51aa0a426cc6b438">geos::linearref::LinearLocation::getSegmentIndex</a></div><div class="ttdeci">size_t getSegmentIndex() const </div><div class="ttdoc">Gets the segment index for this location. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ac3c3cc8aa4a461abf7e125bf8af21012"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ac3c3cc8aa4a461abf7e125bf8af21012">geos::linearref::LinearLocation::segmentFraction</a></div><div class="ttdeci">double segmentFraction</div><div class="ttdef"><b>Definition:</b> <a href="LinearLocation_8h_source.html#l00048">LinearLocation.h:48</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html">geos::linearref::LinearLocation</a></div><div class="ttdoc">Represents a location along a LineString or MultiLineString. </div><div class="ttdef"><b>Definition:</b> <a href="LinearLocation_8h_source.html#l00044">LinearLocation.h:44</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_af3303b29a06005f9aec33f98f13ba06a"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#af3303b29a06005f9aec33f98f13ba06a">geos::linearref::LinearLocation::getSegment</a></div><div class="ttdeci">std::unique_ptr&lt; geom::LineSegment &gt; getSegment(const geom::Geometry *linearGeom) const </div><div class="ttdoc">Gets a LineSegment representing the segment of the given linear Geometry which contains this location...</div></div>
<div class="ttc" id="LineSegment_8h_html"><div class="ttname"><a href="LineSegment_8h.html">LineSegment.h</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_aa2afb586307fce0af72b060354f1c78c"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#aa2afb586307fce0af72b060354f1c78c">geos::linearref::LinearLocation::isOnSameSegment</a></div><div class="ttdeci">bool isOnSameSegment(const LinearLocation &amp;loc) const </div><div class="ttdoc">Tests whether two locations are on the same segment in the parent Geometry. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ad34e67ca38de697d11dc3e255224b920"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ad34e67ca38de697d11dc3e255224b920">geos::linearref::LinearLocation::normalize</a></div><div class="ttdeci">void normalize()</div><div class="ttdoc">Ensures the individual values are locally valid. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a92e789161df73b41357125289d9b767a"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a92e789161df73b41357125289d9b767a">geos::linearref::LinearLocation::isEndpoint</a></div><div class="ttdeci">bool isEndpoint(const geom::Geometry &amp;linearGeom) const </div><div class="ttdoc">Tests whether this location is an endpoint of the linear component it refers to. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_ae9137b3ee11b144d01d928a2ad85ac14"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#ae9137b3ee11b144d01d928a2ad85ac14">geos::linearref::LinearLocation::pointAlongSegmentByFraction</a></div><div class="ttdeci">static geom::Coordinate pointAlongSegmentByFraction(const geom::Coordinate &amp;p0, const geom::Coordinate &amp;p1, double frac)</div><div class="ttdoc">Computes the Coordinate of a point a given fraction along the line segment (p0, p1). </div></div>
<div class="ttc" id="namespacegeos_html"><div class="ttname"><a href="namespacegeos.html">geos</a></div><div class="ttdoc">Basic namespace for all GEOS functionalities. </div><div class="ttdef"><b>Definition:</b> <a href="IndexedNestedRingTester_8h_source.html#l00026">IndexedNestedRingTester.h:26</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_adbc2d0094055a020468c11fd14c504b1"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#adbc2d0094055a020468c11fd14c504b1">geos::linearref::LinearLocation::LinearLocation</a></div><div class="ttdeci">LinearLocation(size_t segmentIndex=0, double segmentFraction=0.0)</div><div class="ttdoc">Creates a location referring to the start of a linear geometry. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a0a7f6a53225266e50cd5e9f74aacd975"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a0a7f6a53225266e50cd5e9f74aacd975">geos::linearref::LinearLocation::isValid</a></div><div class="ttdeci">bool isValid(const geom::Geometry *linearGeom) const </div><div class="ttdoc">Tests whether this location refers to a valid location on the given linear Geometry. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a017a305a4c32502bb87ab61cd569fbc7"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a017a305a4c32502bb87ab61cd569fbc7">geos::linearref::LinearLocation::getEndLocation</a></div><div class="ttdeci">static LinearLocation getEndLocation(const geom::Geometry *linear)</div><div class="ttdoc">Gets a location which refers to the end of a linear Geometry. </div></div>
<div class="ttc" id="Coordinate_8h_html"><div class="ttname"><a href="Coordinate_8h.html">Coordinate.h</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a9480d64cb462dc9ae0aacb9489f2d71a"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a9480d64cb462dc9ae0aacb9489f2d71a">geos::linearref::LinearLocation::setToEnd</a></div><div class="ttdeci">void setToEnd(const geom::Geometry *linear)</div><div class="ttdoc">Sets the value of this location to refer the end of a linear geometry. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_abe73a6c5d10b6bc8f2dbfa5bd25ddc82"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#abe73a6c5d10b6bc8f2dbfa5bd25ddc82">geos::linearref::LinearLocation::snapToVertex</a></div><div class="ttdeci">void snapToVertex(const geom::Geometry *linearGeom, double minDistance)</div><div class="ttdoc">Snaps the value of this location to the nearest vertex on the given linear Geometry, if the vertex is closer than minDistance. </div></div>
<div class="ttc" id="Geometry_8h_html"><div class="ttname"><a href="Geometry_8h.html">Geometry.h</a></div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_aeb879ed9f26e208b409a5911bbd181fc"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#aeb879ed9f26e208b409a5911bbd181fc">geos::linearref::LinearLocation::compareTo</a></div><div class="ttdeci">int compareTo(const LinearLocation &amp;other) const </div><div class="ttdoc">Compares this object with the specified object for order. </div></div>
<div class="ttc" id="classgeos_1_1linearref_1_1LinearLocation_html_a3cf29e0da01a96313ae63759835cba57"><div class="ttname"><a href="classgeos_1_1linearref_1_1LinearLocation.html#a3cf29e0da01a96313ae63759835cba57">geos::linearref::LinearLocation::getComponentIndex</a></div><div class="ttdeci">size_t getComponentIndex() const </div><div class="ttdoc">Gets the component index for this location. </div></div>
</div><!-- fragment --></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>