<!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::relate::RelateOp 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="namespacegeos_1_1operation_1_1relate.html">relate</a> </li>
<li><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html">geos::operation::relate::RelateOp</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::operation::relate::RelateOp Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::operation::relate::RelateOp" --><!-- doxytag: inherits="geos::operation::GeometryGraphOperation" -->
<p>Implements the SFS <code><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html#a694d50ad7d847328be1e9d4caad2373b" title="Computes the geom::IntersectionMatrix for the spatial relationship between two geom::Geometry objects...">relate()</a></code> operation on two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="RelateOp_8h_source.html">RelateOp.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::operation::relate::RelateOp:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1operation_1_1relate_1_1RelateOp.png" usemap="#geos::operation::relate::RelateOp_map" alt=""/>
<map id="geos::operation::relate::RelateOp_map" name="geos::operation::relate::RelateOp_map">
<area href="classgeos_1_1operation_1_1GeometryGraphOperation.html" alt="geos::operation::GeometryGraphOperation" shape="rect" coords="0,0,249,24"/>
</map>
</div>
<p><a href="classgeos_1_1operation_1_1relate_1_1RelateOp-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_1relate_1_1RelateOp.html#a6e4f3dd3ccc2bb1a3a280ce7123417b6">RelateOp</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *g0, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *g1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new Relate operation, using the default (OGC SFS) Boundary Node Rule. <a href="#a6e4f3dd3ccc2bb1a3a280ce7123417b6"></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_1relate_1_1RelateOp.html#a5264569f41695a4ffb55dad9ec4975ac">RelateOp</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *g0, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *g1, 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 new Relate operation with a specified Boundary Node Rule. <a href="#a5264569f41695a4ffb55dad9ec4975ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html#af32949432105d399834b195682ae781b">getIntersectionMatrix</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the IntersectionMatrix for the spatial relationship between the input geometries. <a href="#af32949432105d399834b195682ae781b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html#a694d50ad7d847328be1e9d4caad2373b">relate</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *a, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html" title="Implementation of Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix.">geom::IntersectionMatrix</a> for the spatial relationship between two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects, using the default (OGC SFS) Boundary Node Rule. <a href="#a694d50ad7d847328be1e9d4caad2373b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html#ad5885ee849905f4df93871c98319b135">relate</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *a, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *b, 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">Computes the <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html" title="Implementation of Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix.">geom::IntersectionMatrix</a> for the spatial relationship between two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects, using a specified Boundary Node Rule. <a href="#ad5885ee849905f4df93871c98319b135"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements the SFS <code><a class="el" href="classgeos_1_1operation_1_1relate_1_1RelateOp.html#a694d50ad7d847328be1e9d4caad2373b" title="Computes the geom::IntersectionMatrix for the spatial relationship between two geom::Geometry objects...">relate()</a></code> operation on two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects. </p>
<p>This class supports specifying a custom <a class="el" href="classgeos_1_1algorithm_1_1BoundaryNodeRule.html">algorithm::BoundaryNodeRule</a> to be used during the relate computation.</p>
<p><b>Note:</b> custom Boundary Node Rules do not (currently) affect the results of other Geometry methods (such as <a class="el" href="">Geometry::getBoundary</a>. The results of these methods may not be consistent with the relationship computed by a custom Boundary Node Rule. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6e4f3dd3ccc2bb1a3a280ce7123417b6"></a><!-- doxytag: member="geos::operation::relate::RelateOp::RelateOp" ref="a6e4f3dd3ccc2bb1a3a280ce7123417b6" args="(const geom::Geometry *g0, const geom::Geometry *g1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::relate::RelateOp::RelateOp </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>g0</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>g1</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 new Relate operation, using the default (OGC SFS) 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>g0</em> </td><td>a Geometry to relate. Ownership left to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>g1</em> </td><td>another Geometry to relate. Ownership to caller. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5264569f41695a4ffb55dad9ec4975ac"></a><!-- doxytag: member="geos::operation::relate::RelateOp::RelateOp" ref="a5264569f41695a4ffb55dad9ec4975ac" args="(const geom::Geometry *g0, const geom::Geometry *g1, const algorithm::BoundaryNodeRule &boundaryNodeRule)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::relate::RelateOp::RelateOp </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>g0</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>g1</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 new Relate operation with a specified 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>g0</em> </td><td>a Geometry to relate. Ownership left to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>g1</em> </td><td>another Geometry to relate. Ownership to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>boundaryNodeRule</em> </td><td>the Boundary Node Rule to use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af32949432105d399834b195682ae781b"></a><!-- doxytag: member="geos::operation::relate::RelateOp::getIntersectionMatrix" ref="af32949432105d399834b195682ae781b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a>* geos::operation::relate::RelateOp::getIntersectionMatrix </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the IntersectionMatrix for the spatial relationship between the input geometries. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html" title="Implementation of Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix.">geom::IntersectionMatrix</a> for the spatial relationship between the input geometries. Ownership transferred. </dd></dl>
</div>
</div>
<a class="anchor" id="a694d50ad7d847328be1e9d4caad2373b"></a><!-- doxytag: member="geos::operation::relate::RelateOp::relate" ref="a694d50ad7d847328be1e9d4caad2373b" args="(const geom::Geometry *a, const geom::Geometry *b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a>* geos::operation::relate::RelateOp::relate </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>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html" title="Implementation of Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix.">geom::IntersectionMatrix</a> for the spatial relationship between two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects, using the default (OGC SFS) 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>a</em> </td><td>a Geometry to test. Ownership left to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>b</em> </td><td>a Geometry to test. Ownership left to caller.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the IntersectonMatrix for the spatial relationship between the geometries. Ownership transferred. </dd></dl>
</div>
</div>
<a class="anchor" id="ad5885ee849905f4df93871c98319b135"></a><!-- doxytag: member="geos::operation::relate::RelateOp::relate" ref="ad5885ee849905f4df93871c98319b135" args="(const geom::Geometry *a, const geom::Geometry *b, const algorithm::BoundaryNodeRule &boundaryNodeRule)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html">geom::IntersectionMatrix</a>* geos::operation::relate::RelateOp::relate </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>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>b</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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the <a class="el" href="classgeos_1_1geom_1_1IntersectionMatrix.html" title="Implementation of Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix.">geom::IntersectionMatrix</a> for the spatial relationship between two <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">geom::Geometry</a> objects, using a specified 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>a</em> </td><td>a Geometry to test. Ownership left to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>b</em> </td><td>a Geometry to test. Ownership left to caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>boundaryNodeRule</em> </td><td>the Boundary Node Rule to use.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the IntersectonMatrix for the spatial relationship between the geometries. Ownership transferred. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RelateOp_8h_source.html">RelateOp.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>
