<!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"/>
<title>GEOS: geos::linearref::LinearIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related 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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacegeos.html">geos</a> </li>
<li><b>linearref</b> </li>
<li><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">geos::linearref::LinearIterator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::linearref::LinearIterator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::linearref::LinearIterator" -->
<p><code>#include <<a class="el" href="LinearIterator_8h_source.html">LinearIterator.h</a>></code></p>
<p><a href="classgeos_1_1linearref_1_1LinearIterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </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> *linear)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </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> *linear, const <a class="el" href="classgeos_1_1linearref_1_1LinearLocation.html">LinearLocation</a> &start)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a9eef4f30cac7ff4a35479d381951ce44">LinearIterator</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *linear, unsigned int componentIndex, unsigned int vertexIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a3568ac2c513902a45d8fcd700adb8904">hasNext</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#af71966c14f6a7ede1157c18a001a0af1">next</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a6db3e2de613348d7fb28e26b288cb80a">isEndOfLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a522ea6c160629baa7f16ad749557458c">getComponentIndex</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ae7f4aa8654c964c9ce6db428029381a7">getVertexIndex</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#afa14565649421758be3d65ca32f8c77c">getLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#ad4fa921b57685e846277c1fdc10017f8">getSegmentStart</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html#a90a909bbb22f34ebe2d260684cd3e89b">getSegmentEnd</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An iterator over the components and coordinates of a linear geometry (<a class="el" href="">LineString</a>s and <a class="el" href="">MultiLineString</a>s.</p>
<p>The standard usage pattern for a <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> is:</p>
<pre>
for (<a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a> it = new <a class="el" href="classgeos_1_1linearref_1_1LinearIterator.html">LinearIterator</a>(...); it.hasNext(); it.next()) {
...
int ci = it.getComponentIndex(); // for example
int vi = it.getVertexIndex(); // for example
...
}
</pre><dl class="version"><dt><b>Version:</b></dt><dd>1.7 </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a632426abb87d5f3cc4b6c5fb23da7932"></a><!-- doxytag: member="geos::linearref::LinearIterator::LinearIterator" ref="a632426abb87d5f3cc4b6c5fb23da7932" args="(const geom::Geometry *linear)" -->
<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> * </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 <a class="el" href="">Geometry</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>linear</em> </td><td>the linear geometry to iterate over </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac7c2eb87c4b3cbcff63999612d599daa"></a><!-- doxytag: member="geos::linearref::LinearIterator::LinearIterator" ref="ac7c2eb87c4b3cbcff63999612d599daa" args="(const geom::Geometry *linear, const LinearLocation &start)" -->
<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> * </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> & </td>
<td class="paramname"> <em>start</em></td><td> </td>
</tr>
<tr>
<td></td>
<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">LinearLocation</a> on a linear <a class="el" href="">Geometry</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>linear</em> </td><td>the linear geometry to iterate over </td></tr>
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the location to start at </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9eef4f30cac7ff4a35479d381951ce44"></a><!-- doxytag: member="geos::linearref::LinearIterator::LinearIterator" ref="a9eef4f30cac7ff4a35479d381951ce44" args="(const geom::Geometry *linear, unsigned int componentIndex, unsigned int vertexIndex)" -->
<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> * </td>
<td class="paramname"> <em>linear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>componentIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>vertexIndex</em></td><td> </td>
</tr>
<tr>
<td></td>
<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="">Geometry</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>linear</em> </td><td>the linear geometry to iterate over </td></tr>
<tr><td valign="top"></td><td valign="top"><em>componentIndex</em> </td><td>the component to start at </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vertexIndex</em> </td><td>the vertex to start at </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a522ea6c160629baa7f16ad749557458c"></a><!-- doxytag: member="geos::linearref::LinearIterator::getComponentIndex" ref="a522ea6c160629baa7f16ad749557458c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int 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="return"><dt><b>Returns:</b></dt><dd>the current component index </dd></dl>
</div>
</div>
<a class="anchor" id="afa14565649421758be3d65ca32f8c77c"></a><!-- doxytag: member="geos::linearref::LinearIterator::getLine" ref="afa14565649421758be3d65ca32f8c77c" args="() const " -->
<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="">LineString</a> component the iterator is current at. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a linestring </dd></dl>
</div>
</div>
<a class="anchor" id="a90a909bbb22f34ebe2d260684cd3e89b"></a><!-- doxytag: member="geos::linearref::LinearIterator::getSegmentEnd" ref="a90a909bbb22f34ebe2d260684cd3e89b" args="() const " -->
<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="">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="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="">Coordinate</a> or <code>null</code> </dd></dl>
</div>
</div>
<a class="anchor" id="ad4fa921b57685e846277c1fdc10017f8"></a><!-- doxytag: member="geos::linearref::LinearIterator::getSegmentStart" ref="ad4fa921b57685e846277c1fdc10017f8" args="() const " -->
<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="">Coordinate</a> of the current segment. (the coordinate of the current vertex). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="">Coordinate</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae7f4aa8654c964c9ce6db428029381a7"></a><!-- doxytag: member="geos::linearref::LinearIterator::getVertexIndex" ref="ae7f4aa8654c964c9ce6db428029381a7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int 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="return"><dt><b>Returns:</b></dt><dd>the current vertex index </dd></dl>
</div>
</div>
<a class="anchor" id="a3568ac2c513902a45d8fcd700adb8904"></a><!-- doxytag: member="geos::linearref::LinearIterator::hasNext" ref="a3568ac2c513902a45d8fcd700adb8904" args="() const " -->
<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="return"><dt><b>Returns:</b></dt><dd><code>true</code> if there are more vertices to scan </dd></dl>
</div>
</div>
<a class="anchor" id="a6db3e2de613348d7fb28e26b288cb80a"></a><!-- doxytag: member="geos::linearref::LinearIterator::isEndOfLine" ref="a6db3e2de613348d7fb28e26b288cb80a" args="() const " -->
<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 linestring.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</true> if the iterator is at an endpoint </code></dd></dl>
</div>
</div>
<a class="anchor" id="af71966c14f6a7ede1157c18a001a0af1"></a><!-- doxytag: member="geos::linearref::LinearIterator::next" ref="af71966c14f6a7ede1157c18a001a0af1" args="()" -->
<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>
<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>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
