<!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::geom::CoordinateSequenceFilter 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><a class="el" href="namespacegeos_1_1geom.html">geom</a> </li>
<li><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html">geos::geom::CoordinateSequenceFilter</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::geom::CoordinateSequenceFilter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::geom::CoordinateSequenceFilter" -->
<p><code>#include <<a class="el" href="CoordinateSequenceFilter_8h_source.html">CoordinateSequenceFilter.h</a>></code></p>
<p>Inherited by geos::algorithm::distance::DiscreteHausdorffDistance::MaxDensifiedByFractionDistanceFilter.</p>
<p><a href="classgeos_1_1geom_1_1CoordinateSequenceFilter-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html#ab653748377e1c40c83dc3ca5702239bb">filter_rw</a> (<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &, size_t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html#adf14c00a8cfea460caf9d920c8052ccc">filter_ro</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &, size_t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html#a42578ad728c920900bebfa865542337d">isDone</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html#aec7d0010ddc152e08009240a40a59e6d">isGeometryChanged</a> () const =0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface for classes which provide operations that can be applied to the coordinates in a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>. A <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a> filter can either record information about each coordinate or change the coordinate in some way. <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a> filters can be used to implement such things as coordinate transformations, centroid and envelope computation, and many other functions. For maximum efficiency, the execution of filters can be short-circuited. <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> classes support the concept of applying a <code><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html">CoordinateSequenceFilter</a></code> to each <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>s they contain. </p>
<p><code><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html">CoordinateSequenceFilter</a></code> is an example of the Gang-of-Four Visitor pattern.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>Geometry::apply_ro(CoordinateSequenceFilter) </dd>
<dd>
Geometry::apply_rw(CoordinateSequenceFilter) </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Martin Davis </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf14c00a8cfea460caf9d920c8052ccc"></a><!-- doxytag: member="geos::geom::CoordinateSequenceFilter::filter_ro" ref="adf14c00a8cfea460caf9d920c8052ccc" args="(const CoordinateSequence &, size_t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::geom::CoordinateSequenceFilter::filter_ro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs an operation on a coordinate in a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</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>seq</em> </td><td>the <code><a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a></code> to which the filter is applied </td></tr>
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the index of the coordinate to apply the filter to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab653748377e1c40c83dc3ca5702239bb"></a><!-- doxytag: member="geos::geom::CoordinateSequenceFilter::filter_rw" ref="ab653748377e1c40c83dc3ca5702239bb" args="(CoordinateSequence &, size_t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::geom::CoordinateSequenceFilter::filter_rw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs an operation on a coordinate in a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</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>seq</em> </td><td>the <code><a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a></code> to which the filter is applied </td></tr>
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the index of the coordinate to apply the filter to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a42578ad728c920900bebfa865542337d"></a><!-- doxytag: member="geos::geom::CoordinateSequenceFilter::isDone" ref="a42578ad728c920900bebfa865542337d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool geos::geom::CoordinateSequenceFilter::isDone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reports whether the application of this filter can be terminated. Once this method returns <code>false</code>, it should continue to return <code>false</code> on every subsequent call.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the application of this filter can be terminated. </dd></dl>
</div>
</div>
<a class="anchor" id="aec7d0010ddc152e08009240a40a59e6d"></a><!-- doxytag: member="geos::geom::CoordinateSequenceFilter::isGeometryChanged" ref="aec7d0010ddc152e08009240a40a59e6d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool geos::geom::CoordinateSequenceFilter::isGeometryChanged </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reports whether the execution of this filter has modified the coordinates of the geometry. If so, <a class="el" href="">Geometry#geometryChanged</a> will be executed after this filter has finished being executed.</p>
<p>Most filters can simply return a constant value reflecting whether they are able to change the coordinates.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this filter has changed the coordinates of the geometry </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CoordinateSequenceFilter_8h_source.html">CoordinateSequenceFilter.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>
