geos_390_docs/classgeos_1_1linearref_1_1L...

614 lines
35 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::LinearIterator 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_1LinearIterator.html">LinearIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1linearref_1_1LinearIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::linearref::LinearIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An iterator over the components and coordinates of a linear geometry (LineString or MultiLineString).
<a href="classgeos_1_1linearref_1_1LinearIterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::linearref::LinearIterator:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgeos_1_1linearref_1_1LinearIterator__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:a632426abb87d5f3cc4b6c5fb23da7932"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a632426abb87d5f3cc4b6c5fb23da7932">LinearIterator</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a2138e21b499134f0b72184e26b36c0d0">linear</a>)</td></tr>
<tr class="memdesc:a632426abb87d5f3cc4b6c5fb23da7932"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an iterator initialized to the start of a linear Geometry. <a href="#a632426abb87d5f3cc4b6c5fb23da7932">More...</a><br /></td></tr>
<tr class="separator:a632426abb87d5f3cc4b6c5fb23da7932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c2eb87c4b3cbcff63999612d599daa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ac7c2eb87c4b3cbcff63999612d599daa">LinearIterator</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a2138e21b499134f0b72184e26b36c0d0">linear</a>, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;start)</td></tr>
<tr class="memdesc:ac7c2eb87c4b3cbcff63999612d599daa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an iterator starting at a <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> on a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory. ">geom::Geometry</a>. <a href="#ac7c2eb87c4b3cbcff63999612d599daa">More...</a><br /></td></tr>
<tr class="separator:ac7c2eb87c4b3cbcff63999612d599daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81719560149c4a528b1a81ccdb24360f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a81719560149c4a528b1a81ccdb24360f">LinearIterator</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *<a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a2138e21b499134f0b72184e26b36c0d0">linear</a>, size_t <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ae050428011dfe6f609b108e7193a63f9">componentIndex</a>, size_t <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ae8471c2444655e2233bf383ec57cc7cd">vertexIndex</a>)</td></tr>
<tr class="memdesc:a81719560149c4a528b1a81ccdb24360f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an iterator starting at a component and vertex in a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory. ">geom::Geometry</a>. <a href="#a81719560149c4a528b1a81ccdb24360f">More...</a><br /></td></tr>
<tr class="separator:a81719560149c4a528b1a81ccdb24360f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3568ac2c513902a45d8fcd700adb8904"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a3568ac2c513902a45d8fcd700adb8904">hasNext</a> () const </td></tr>
<tr class="memdesc:a3568ac2c513902a45d8fcd700adb8904"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests whether there are any vertices left to iterator over. <a href="#a3568ac2c513902a45d8fcd700adb8904">More...</a><br /></td></tr>
<tr class="separator:a3568ac2c513902a45d8fcd700adb8904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af71966c14f6a7ede1157c18a001a0af1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#af71966c14f6a7ede1157c18a001a0af1">next</a> ()</td></tr>
<tr class="memdesc:af71966c14f6a7ede1157c18a001a0af1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the iterator ahead to the next vertex and (possibly) linear component. <a href="#af71966c14f6a7ede1157c18a001a0af1">More...</a><br /></td></tr>
<tr class="separator:af71966c14f6a7ede1157c18a001a0af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6db3e2de613348d7fb28e26b288cb80a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a6db3e2de613348d7fb28e26b288cb80a">isEndOfLine</a> () const </td></tr>
<tr class="memdesc:a6db3e2de613348d7fb28e26b288cb80a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the iterator cursor is pointing to the endpoint of a component <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>. <a href="#a6db3e2de613348d7fb28e26b288cb80a">More...</a><br /></td></tr>
<tr class="separator:a6db3e2de613348d7fb28e26b288cb80a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a540a187054e143d404a4ddd8f0c3dda9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a540a187054e143d404a4ddd8f0c3dda9">getComponentIndex</a> () const </td></tr>
<tr class="memdesc:a540a187054e143d404a4ddd8f0c3dda9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The component index of the vertex the iterator is currently at. <a href="#a540a187054e143d404a4ddd8f0c3dda9">More...</a><br /></td></tr>
<tr class="separator:a540a187054e143d404a4ddd8f0c3dda9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af74adfda6c19dbe1ddcf15339daa834a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#af74adfda6c19dbe1ddcf15339daa834a">getVertexIndex</a> () const </td></tr>
<tr class="memdesc:af74adfda6c19dbe1ddcf15339daa834a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The vertex index of the vertex the iterator is currently at. <a href="#af74adfda6c19dbe1ddcf15339daa834a">More...</a><br /></td></tr>
<tr class="separator:af74adfda6c19dbe1ddcf15339daa834a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa14565649421758be3d65ca32f8c77c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#afa14565649421758be3d65ca32f8c77c">getLine</a> () const </td></tr>
<tr class="memdesc:afa14565649421758be3d65ca32f8c77c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> component the iterator is current at. <a href="#afa14565649421758be3d65ca32f8c77c">More...</a><br /></td></tr>
<tr class="separator:afa14565649421758be3d65ca32f8c77c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4fa921b57685e846277c1fdc10017f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ad4fa921b57685e846277c1fdc10017f8">getSegmentStart</a> () const </td></tr>
<tr class="memdesc:ad4fa921b57685e846277c1fdc10017f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the first <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates. ">geom::Coordinate</a> of the current segment. (the coordinate of the current vertex). <a href="#ad4fa921b57685e846277c1fdc10017f8">More...</a><br /></td></tr>
<tr class="separator:ad4fa921b57685e846277c1fdc10017f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a909bbb22f34ebe2d260684cd3e89b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a90a909bbb22f34ebe2d260684cd3e89b">getSegmentEnd</a> () const </td></tr>
<tr class="memdesc:a90a909bbb22f34ebe2d260684cd3e89b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the second <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates. ">geom::Coordinate</a> of the current segment. (the coordinate of the next vertex). If the iterator is at the end of a line, <code>null</code> is returned. <a href="#a90a909bbb22f34ebe2d260684cd3e89b">More...</a><br /></td></tr>
<tr class="separator:a90a909bbb22f34ebe2d260684cd3e89b"><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:a1866f7614d1dd934321d4804eb34c7ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a1866f7614d1dd934321d4804eb34c7ea">loadCurrentLine</a> ()</td></tr>
<tr class="separator:a1866f7614d1dd934321d4804eb34c7ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a061849f52d864ff577d5276346a711a3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a061849f52d864ff577d5276346a711a3">LinearIterator</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> &amp;other)=delete</td></tr>
<tr class="separator:a061849f52d864ff577d5276346a711a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad12a463234c4db7576178b491a58054a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ad12a463234c4db7576178b491a58054a">operator=</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> &amp;rhs)=delete</td></tr>
<tr class="separator:ad12a463234c4db7576178b491a58054a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a6770d7d44d312b7bc5d38294e577571d"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a6770d7d44d312b7bc5d38294e577571d">segmentEndVertexIndex</a> (const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &amp;loc)</td></tr>
<tr class="separator:a6770d7d44d312b7bc5d38294e577571d"><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:a80a5765bf1d727fae7d675ed1451ac36"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a80a5765bf1d727fae7d675ed1451ac36">currentLine</a></td></tr>
<tr class="separator:a80a5765bf1d727fae7d675ed1451ac36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8471c2444655e2233bf383ec57cc7cd"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ae8471c2444655e2233bf383ec57cc7cd">vertexIndex</a></td></tr>
<tr class="separator:ae8471c2444655e2233bf383ec57cc7cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae050428011dfe6f609b108e7193a63f9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ae050428011dfe6f609b108e7193a63f9">componentIndex</a></td></tr>
<tr class="separator:ae050428011dfe6f609b108e7193a63f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2138e21b499134f0b72184e26b36c0d0"><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_1LinearIterator.html#a2138e21b499134f0b72184e26b36c0d0">linear</a></td></tr>
<tr class="separator:a2138e21b499134f0b72184e26b36c0d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed6ac2df6ce216691a769a33955865da"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#aed6ac2df6ce216691a769a33955865da">numLines</a></td></tr>
<tr class="separator:aed6ac2df6ce216691a769a33955865da"><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>An iterator over the components and coordinates of a linear geometry (LineString or MultiLineString). </p>
<p>The standard usage pattern for a <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html" title="An iterator over the components and coordinates of a linear geometry (LineString or MultiLineString)...">LinearIterator</a> is:</p>
<div class="fragment"><div class="line"><span class="keywordflow">for</span> (<a class="code" href="classgeos_1_1linearref_1_1LinearIterator.html#a632426abb87d5f3cc4b6c5fb23da7932">LinearIterator</a> it = <span class="keyword">new</span> <a class="code" href="classgeos_1_1linearref_1_1LinearIterator.html#a632426abb87d5f3cc4b6c5fb23da7932">LinearIterator</a>(...); it.hasNext(); it.next()) {</div><div class="line"> ...</div><div class="line"> <span class="keywordtype">int</span> ci = it.getComponentIndex(); <span class="comment">// for example</span></div><div class="line"> <span class="keywordtype">int</span> vi = it.getVertexIndex(); <span class="comment">// for example</span></div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --><dl class="section version"><dt>Version</dt><dd>1.7 </dd></dl>
<p>Definition at line <a class="el" href="LinearIterator_8h_source.html#l00050">50</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a632426abb87d5f3cc4b6c5fb23da7932"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LinearIterator::LinearIterator </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>
</div><div class="memdoc">
<p>Creates an iterator initialized to the start of a linear Geometry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">linear</td><td>the linear geometry to iterate over </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac7c2eb87c4b3cbcff63999612d599daa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LinearIterator::LinearIterator </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>
</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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an iterator starting at a <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html" title="Represents a location along a LineString or MultiLineString. ">LinearLocation</a> on a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory. ">geom::Geometry</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">linear</td><td>the linear geometry to iterate over </td></tr>
<tr><td class="paramname">start</td><td>the location to start at </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a81719560149c4a528b1a81ccdb24360f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LinearIterator::LinearIterator </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>componentIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>vertexIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an iterator starting at a component and vertex in a linear <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory. ">geom::Geometry</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">linear</td><td>the linear geometry to iterate over </td></tr>
<tr><td class="paramname">componentIndex</td><td>the component to start at </td></tr>
<tr><td class="paramname">vertexIndex</td><td>the vertex to start at </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a061849f52d864ff577d5276346a711a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::linearref::LinearIterator::LinearIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a540a187054e143d404a4ddd8f0c3dda9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t geos::linearref::LinearIterator::getComponentIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The component index of the vertex the iterator is currently at. </p>
<dl class="section return"><dt>Returns</dt><dd>the current component index </dd></dl>
</div>
</div>
<a class="anchor" id="afa14565649421758be3d65ca32f8c77c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>* geos::linearref::LinearIterator::getLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> component the iterator is current at. </p>
<dl class="section return"><dt>Returns</dt><dd>a linestring </dd></dl>
</div>
</div>
<a class="anchor" id="a90a909bbb22f34ebe2d260684cd3e89b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> geos::linearref::LinearIterator::getSegmentEnd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the second <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates. ">geom::Coordinate</a> of the current segment. (the coordinate of the next vertex). If the iterator is at the end of a line, <code>null</code> is returned. </p>
<dl class="section return"><dt>Returns</dt><dd>a Coordinate or <code>null</code> </dd></dl>
</div>
</div>
<a class="anchor" id="ad4fa921b57685e846277c1fdc10017f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> geos::linearref::LinearIterator::getSegmentStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the first <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates. ">geom::Coordinate</a> of the current segment. (the coordinate of the current vertex). </p>
<dl class="section return"><dt>Returns</dt><dd>a Coordinate </dd></dl>
</div>
</div>
<a class="anchor" id="af74adfda6c19dbe1ddcf15339daa834a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t geos::linearref::LinearIterator::getVertexIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The vertex index of the vertex the iterator is currently at. </p>
<dl class="section return"><dt>Returns</dt><dd>the current vertex index </dd></dl>
</div>
</div>
<a class="anchor" id="a3568ac2c513902a45d8fcd700adb8904"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::linearref::LinearIterator::hasNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests whether there are any vertices left to iterator over. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if there are more vertices to scan </dd></dl>
</div>
</div>
<a class="anchor" id="a6db3e2de613348d7fb28e26b288cb80a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::linearref::LinearIterator::isEndOfLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the iterator cursor is pointing to the endpoint of a component <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the iterator is at an endpoint </dd></dl>
</div>
</div>
<a class="anchor" id="a1866f7614d1dd934321d4804eb34c7ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::linearref::LinearIterator::loadCurrentLine </td>
<td>(</td>
<td class="paramname"></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>Invariant: currentLine &lt;&gt; null if the iterator is pointing at a valid coordinate</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if linearGeom is not <a class="el" href="">Lineal</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af71966c14f6a7ede1157c18a001a0af1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::linearref::LinearIterator::next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves the iterator ahead to the next vertex and (possibly) linear component. </p>
</div>
</div>
<a class="anchor" id="ad12a463234c4db7576178b491a58054a"></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_1LinearIterator.html">LinearIterator</a>&amp; geos::linearref::LinearIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6770d7d44d312b7bc5d38294e577571d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static size_t geos::linearref::LinearIterator::segmentEndVertexIndex </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>loc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><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="ae050428011dfe6f609b108e7193a63f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t geos::linearref::LinearIterator::componentIndex</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="LinearIterator_8h_source.html#l00138">138</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a80a5765bf1d727fae7d675ed1451ac36"></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_1LineString.html">geom::LineString</a>* geos::linearref::LinearIterator::currentLine</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="LinearIterator_8h_source.html#l00136">136</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2138e21b499134f0b72184e26b36c0d0"></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::LinearIterator::linear</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="LinearIterator_8h_source.html#l00139">139</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed6ac2df6ce216691a769a33955865da"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const size_t geos::linearref::LinearIterator::numLines</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="LinearIterator_8h_source.html#l00140">140</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae8471c2444655e2233bf383ec57cc7cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t geos::linearref::LinearIterator::vertexIndex</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="LinearIterator_8h_source.html#l00137">137</a> of file <a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LinearIterator_8h_source.html">LinearIterator.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>