<!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::CoordinateFilter 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_1CoordinateFilter.html">geos::geom::CoordinateFilter</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::CoordinateFilter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::geom::CoordinateFilter" -->
<p><code>#include <<a class="el" href="CoordinateFilter_8h_source.html">CoordinateFilter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::geom::CoordinateFilter:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1geom_1_1CoordinateFilter.png" usemap="#geos::geom::CoordinateFilter_map" alt=""/>
<map id="geos::geom::CoordinateFilter_map" name="geos::geom::CoordinateFilter_map">
<area href="classgeos_1_1util_1_1CoordinateArrayFilter.html" alt="geos::util::CoordinateArrayFilter" shape="rect" coords="0,56,191,80"/>
</map>
</div>
<p><a href="classgeos_1_1geom_1_1CoordinateFilter-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_1CoordinateFilter.html#a17c96b1adac371dbbc0ddce2307a8a53">filter_rw</a> (<a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> *) const </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_1CoordinateFilter.html#ad2162035396313e6a665d50a7eeba2e9">filter_ro</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><code><a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a></code> classes support the concept of applying a coordinate filter to every coordinate in the <code><a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a></code>.</p>
<p>A coordinate filter can either record information about each coordinate or change the coordinate in some way. <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a> filters implement the interface <code><a class="el" href="classgeos_1_1geom_1_1CoordinateFilter.html">CoordinateFilter</a></code>. (<code><a class="el" href="classgeos_1_1geom_1_1CoordinateFilter.html">CoordinateFilter</a></code> is an example of the Gang-of-Four Visitor pattern). <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a> filters can be used to implement such things as coordinate transformations, centroid and envelope computation, and many other functions.</p>
<p>TODO: provide geom::CoordinateInspector and geom::CoordinateMutator instead of having the two versions of filter_rw and filter_ro </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad2162035396313e6a665d50a7eeba2e9"></a><!-- doxytag: member="geos::geom::CoordinateFilter::filter_ro" ref="ad2162035396313e6a665d50a7eeba2e9" args="(const Coordinate *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::geom::CoordinateFilter::filter_ro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> * </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs an operation with <code>coord</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>coord</em> </td><td>a <code><a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a></code> to which the filter is applied. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classgeos_1_1util_1_1CoordinateArrayFilter.html#a8bde6449777979f67d523836c8cc448a">geos::util::CoordinateArrayFilter</a>.</p>
</div>
</div>
<a class="anchor" id="a17c96b1adac371dbbc0ddce2307a8a53"></a><!-- doxytag: member="geos::geom::CoordinateFilter::filter_rw" ref="a17c96b1adac371dbbc0ddce2307a8a53" args="(Coordinate *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::geom::CoordinateFilter::filter_rw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> * </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs an operation on <code>coord</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>coord</em> </td><td>a <code><a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a></code> to which the filter is applied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CoordinateFilter_8h_source.html">CoordinateFilter.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>
