<!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::operation::IsSimpleOp 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_1operation.html">operation</a> </li>
<li><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html">geos::operation::IsSimpleOp</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::operation::IsSimpleOp Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::operation::IsSimpleOp" -->
<p>Tests whether a Geometry is simple.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="IsSimpleOp_8h_source.html">IsSimpleOp.h</a>></code></p>
<p><a href="classgeos_1_1operation_1_1IsSimpleOp-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_1operation_1_1IsSimpleOp.html#a6b536b02b8473e8f5bcc2d872b56a04e">IsSimpleOp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a simplicity checker using the default SFS Mod-2 Boundary Node Rule. <a href="#a6b536b02b8473e8f5bcc2d872b56a04e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a2ade8a6be5d538afa52852748ea2e81c">IsSimpleOp</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &geom)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a simplicity checker using the default SFS Mod-2 Boundary Node Rule. <a href="#a2ade8a6be5d538afa52852748ea2e81c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a77a7bb4cd4a7cc5a3800e888ee01772b">IsSimpleOp</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &geom, const <a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</a> &boundaryNodeRule)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a simplicity checker using a given <a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</a>. <a href="#a77a7bb4cd4a7cc5a3800e888ee01772b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a933b80539f97ba6c16cdfa2b1c4b8ac0">isSimple</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <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_1operation_1_1IsSimpleOp.html#a6f13e6c9d4501fd372366332e1f434f6">getNonSimpleLocation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#aebe2085a626547b0a4e41d8f4337cba4">isSimple</a> (const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> *geom)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a3b0ca866d4112b9f0461f7958563ba3c">isSimple</a> (const <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">geom::MultiLineString</a> *geom)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#aaf1f574450e3f9d09b9305ab459005c0">isSimple</a> (const <a class="el" href="classgeos_1_1geom_1_1MultiPoint.html">geom::MultiPoint</a> *mp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99f8948403d5d3fb167e895f008c4d5c"></a><!-- doxytag: member="geos::operation::IsSimpleOp::isSimpleLinearGeometry" ref="a99f8948403d5d3fb167e895f008c4d5c" args="(const geom::Geometry *geom)" -->
bool </td><td class="memItemRight" valign="bottom"><b>isSimpleLinearGeometry</b> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geom)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Tests whether a Geometry is simple. </p>
<p>In general, the SFS specification of simplicity follows the rule:</p>
<ul>
<li>A Geometry is simple if and only if the only self-intersections are at boundary points.</li>
</ul>
<p>This definition relies on the definition of boundary points. The SFS uses the Mod-2 rule to determine which points are on the boundary of lineal geometries, but this class supports using other <a class="el" href="">BoundaryNodeRule</a>s as well.</p>
<p>Simplicity is defined for each <a class="el" href="">Geometry</a> subclass as follows:</p>
<ul>
<li>Valid polygonal geometries are simple by definition, so <code>isSimple</code> trivially returns true. (Hint: in order to check if a polygonal geometry has self-intersections, use <a class="el" href="">Geometry::isValid</a>).</li>
</ul>
<ul>
<li>Linear geometries are simple iff they do not self-intersect at points other than boundary points. (Using the Mod-2 rule, this means that closed linestrings cannot be touched at their endpoints, since these are interior points, not boundary points).</li>
</ul>
<ul>
<li>Zero-dimensional geometries (points) are simple iff they have no repeated points.</li>
</ul>
<ul>
<li>Empty <code>Geometry</code>s are always simple</li>
</ul>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</a> </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6b536b02b8473e8f5bcc2d872b56a04e"></a><!-- doxytag: member="geos::operation::IsSimpleOp::IsSimpleOp" ref="a6b536b02b8473e8f5bcc2d872b56a04e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::IsSimpleOp::IsSimpleOp </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a simplicity checker using the default SFS Mod-2 Boundary Node Rule. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>use IsSimpleOp(Geometry) </dd></dl>
</div>
</div>
<a class="anchor" id="a2ade8a6be5d538afa52852748ea2e81c"></a><!-- doxytag: member="geos::operation::IsSimpleOp::IsSimpleOp" ref="a2ade8a6be5d538afa52852748ea2e81c" args="(const geom::Geometry &geom)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::IsSimpleOp::IsSimpleOp </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>geom</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a simplicity checker using the default SFS Mod-2 Boundary Node Rule. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>The geometry to test. Will store a reference: keep it alive. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a77a7bb4cd4a7cc5a3800e888ee01772b"></a><!-- doxytag: member="geos::operation::IsSimpleOp::IsSimpleOp" ref="a77a7bb4cd4a7cc5a3800e888ee01772b" args="(const geom::Geometry &geom, const algorithm::BoundaryNodeRule &boundaryNodeRule)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::IsSimpleOp::IsSimpleOp </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>geom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</a> & </td>
<td class="paramname"> <em>boundaryNodeRule</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a simplicity checker using a given <a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</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>geom</em> </td><td>the geometry to test </td></tr>
<tr><td valign="top"></td><td valign="top"><em>boundaryNodeRule</em> </td><td>the rule to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6f13e6c9d4501fd372366332e1f434f6"></a><!-- doxytag: member="geos::operation::IsSimpleOp::getNonSimpleLocation" ref="a6f13e6c9d4501fd372366332e1f434f6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>* geos::operation::IsSimpleOp::getNonSimpleLocation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a coordinate for the location where the geometry fails to be simple. (i.e. where it has a non-boundary self-intersection). <a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a933b80539f97ba6c16cdfa2b1c4b8ac0">isSimple</a> must be called before this method is called.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a coordinate for the location of the non-boundary self-intersection. Ownership retained. </dd>
<dd>
the null coordinate if the geometry is simple </dd></dl>
</div>
</div>
<a class="anchor" id="a933b80539f97ba6c16cdfa2b1c4b8ac0"></a><!-- doxytag: member="geos::operation::IsSimpleOp::isSimple" ref="a933b80539f97ba6c16cdfa2b1c4b8ac0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::IsSimpleOp::isSimple </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests whether the geometry is simple.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the geometry is simple </dd></dl>
</div>
</div>
<a class="anchor" id="aaf1f574450e3f9d09b9305ab459005c0"></a><!-- doxytag: member="geos::operation::IsSimpleOp::isSimple" ref="aaf1f574450e3f9d09b9305ab459005c0" args="(const geom::MultiPoint *mp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::IsSimpleOp::isSimple </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1MultiPoint.html">geom::MultiPoint</a> * </td>
<td class="paramname"> <em>mp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A MultiPoint is simple iff it has no repeated points</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>use <a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a933b80539f97ba6c16cdfa2b1c4b8ac0">isSimple()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3b0ca866d4112b9f0461f7958563ba3c"></a><!-- doxytag: member="geos::operation::IsSimpleOp::isSimple" ref="a3b0ca866d4112b9f0461f7958563ba3c" args="(const geom::MultiLineString *geom)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::IsSimpleOp::isSimple </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">geom::MultiLineString</a> * </td>
<td class="paramname"> <em>geom</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reports whether a <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">geom::MultiLineString</a> is simple.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>the lineal geometry to test </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the geometry is simple</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>use <a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a933b80539f97ba6c16cdfa2b1c4b8ac0">isSimple()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aebe2085a626547b0a4e41d8f4337cba4"></a><!-- doxytag: member="geos::operation::IsSimpleOp::isSimple" ref="aebe2085a626547b0a4e41d8f4337cba4" args="(const geom::LineString *geom)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::operation::IsSimpleOp::isSimple </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> * </td>
<td class="paramname"> <em>geom</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reports whether a <a class="el" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">geom::LineString</a> is simple.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>the lineal geometry to test </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the geometry is simple</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>use <a class="el" href="classgeos_1_1operation_1_1IsSimpleOp.html#a933b80539f97ba6c16cdfa2b1c4b8ac0">isSimple()</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="IsSimpleOp_8h_source.html">IsSimpleOp.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>
