<!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::LinearRing 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_1LinearRing.html">geos::geom::LinearRing</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::LinearRing Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::geom::LinearRing" --><!-- doxytag: inherits="geos::geom::LineString" -->
<p>Models an OGC SFS <code><a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a></code>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="LinearRing_8h_source.html">LinearRing.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::geom::LinearRing:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1geom_1_1LinearRing.png" usemap="#geos::geom::LinearRing_map" alt=""/>
<map id="geos::geom::LinearRing_map" name="geos::geom::LinearRing_map">
<area href="classgeos_1_1geom_1_1LineString.html" alt="geos::geom::LineString" shape="rect" coords="0,56,142,80"/>
<area href="classgeos_1_1geom_1_1Geometry.html" alt="geos::geom::Geometry" shape="rect" coords="0,0,142,24"/>
</map>
</div>
<p><a href="classgeos_1_1geom_1_1LinearRing-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"><a class="anchor" id="ac0afbacd7e02521aad78368f937596dc"></a><!-- doxytag: member="geos::geom::LinearRing::LinearRing" ref="ac0afbacd7e02521aad78368f937596dc" args="(const LinearRing &lr)" -->
</td><td class="memItemRight" valign="bottom"><b>LinearRing</b> (const <a class="el" href="classgeos_1_1geom_1_1LinearRing.html">LinearRing</a> &lr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#affd1a5e398e249bf9bdd19a322ced23c">LinearRing</a> (<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> *points, const <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a> *newFactory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <code><a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a></code> with the given points. <a href="#affd1a5e398e249bf9bdd19a322ced23c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73c07256aefd7c32d1eaf8a46379a1fc"></a><!-- doxytag: member="geos::geom::LinearRing::LinearRing" ref="a73c07256aefd7c32d1eaf8a46379a1fc" args="(CoordinateSequence::AutoPtr points, const GeometryFactory *newFactory)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#a73c07256aefd7c32d1eaf8a46379a1fc">LinearRing</a> (CoordinateSequence::AutoPtr points, const <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a> *newFactory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hopefully cleaner version of the above. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#ad41750bf8dc19b903dfa68c9bbc2f19c">clone</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#a4cd9abaa021c435ccedefdcae7fb527d">getBoundaryDimension</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>Dimension.FALSE</code>, since by definition LinearRings do not have a boundary. <a href="#a4cd9abaa021c435ccedefdcae7fb527d"></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_1geom_1_1LinearRing.html#ac8641194f47e3aaa9dd3806bacf8b462">isSimple</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code>, since by definition LinearRings are always simple. <a href="#ac8641194f47e3aaa9dd3806bacf8b462"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1657ec7631dfc3b33406502f05a8521"></a><!-- doxytag: member="geos::geom::LinearRing::getGeometryType" ref="af1657ec7631dfc3b33406502f05a8521" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#af1657ec7631dfc3b33406502f05a8521">getGeometryType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of this <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb3012616411f0006ff80ff601f356bf"></a><!-- doxytag: member="geos::geom::LinearRing::getGeometryTypeId" ref="abb3012616411f0006ff80ff601f356bf" args="() const " -->
virtual <a class="el" href="namespacegeos_1_1geom.html#a98c5b0e81001a7c3fdc7a058960356d8">GeometryTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#abb3012616411f0006ff80ff601f356bf">getGeometryTypeId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an integer representation of this <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a897c940884f7ef5eaf900a257ba1e148"></a><!-- doxytag: member="geos::geom::LinearRing::setPoints" ref="a897c940884f7ef5eaf900a257ba1e148" args="(CoordinateSequence *cl)" -->
void </td><td class="memItemRight" valign="bottom"><b>setPoints</b> (<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> *cl)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1LinearRing.html#a793d1b3dbcef742b10041fc11bffb3a2">reverse</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Models an OGC SFS <code><a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a></code>. </p>
<p>A <a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a> is a <a class="el" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> which is both closed and simple. In other words, the first and last coordinate in the ring must be equal, and the interior of the ring must not self-intersect. Either orientation of the ring is allowed.</p>
<p>A ring must have either 0 or 4 or more points. The first and last points must be equal (in 2D). If these conditions are not met, the constructors throw an <a class="el" href="">IllegalArgumentException</a> </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="affd1a5e398e249bf9bdd19a322ced23c"></a><!-- doxytag: member="geos::geom::LinearRing::LinearRing" ref="affd1a5e398e249bf9bdd19a322ced23c" args="(CoordinateSequence *points, const GeometryFactory *newFactory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::geom::LinearRing::LinearRing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> * </td>
<td class="paramname"> <em>points</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a> * </td>
<td class="paramname"> <em>newFactory</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a <code><a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a></code> with the given points. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>points</em> </td><td>points forming a closed and simple linestring, or <code>null</code> or an empty array to create the empty geometry. This array must not contain <code>null</code> elements. If not null <a class="el" href="classgeos_1_1geom_1_1LinearRing.html" title="Models an OGC SFS LinearRing.">LinearRing</a> will take ownership of points.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>newFactory</em> </td><td>the <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html" title="Supplies a set of utility methods for building Geometry objects from CoordinateSequence or other Geom...">GeometryFactory</a> used to create this geometry </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad41750bf8dc19b903dfa68c9bbc2f19c"></a><!-- doxytag: member="geos::geom::LinearRing::clone" ref="ad41750bf8dc19b903dfa68c9bbc2f19c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>* geos::geom::LinearRing::clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates and returns a full copy of this <a class="el" href="classgeos_1_1geom_1_1LineString.html">LineString</a> object. (including all coordinates contained by it).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a clone of this instance </dd></dl>
<p>Reimplemented from <a class="el" href="classgeos_1_1geom_1_1LineString.html#aebd169c82f9a33b8e8ac9b2664eaab79">geos::geom::LineString</a>.</p>
</div>
</div>
<a class="anchor" id="a4cd9abaa021c435ccedefdcae7fb527d"></a><!-- doxytag: member="geos::geom::LinearRing::getBoundaryDimension" ref="a4cd9abaa021c435ccedefdcae7fb527d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int geos::geom::LinearRing::getBoundaryDimension </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>Dimension.FALSE</code>, since by definition LinearRings do not have a boundary. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classgeos_1_1geom_1_1Dimension.html#af46f1c0c325eb685fcf32987748d04cfa5055f3028cec299275cd330122f086e2" title="Dimension value of the empty geometry (-1).">Dimension::False</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classgeos_1_1geom_1_1LineString.html#a8e9f2bd5b59ee069293638bf6ede61ed">geos::geom::LineString</a>.</p>
</div>
</div>
<a class="anchor" id="ac8641194f47e3aaa9dd3806bacf8b462"></a><!-- doxytag: member="geos::geom::LinearRing::isSimple" ref="ac8641194f47e3aaa9dd3806bacf8b462" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::geom::LinearRing::isSimple </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code>, since by definition LinearRings are always simple. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code></dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgeos_1_1geom_1_1Geometry.html#af4b0804bd3903ed656b38b4561e3e577" title="Returns false if the Geometry not simple.">Geometry::isSimple</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classgeos_1_1geom_1_1Geometry.html#af4b0804bd3903ed656b38b4561e3e577">geos::geom::Geometry</a>.</p>
</div>
</div>
<a class="anchor" id="a793d1b3dbcef742b10041fc11bffb3a2"></a><!-- doxytag: member="geos::geom::LinearRing::reverse" ref="a793d1b3dbcef742b10041fc11bffb3a2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>* geos::geom::LinearRing::reverse </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a <a class="el" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> whose coordinates are in the reverse order of this objects</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> with coordinates in the reverse order </dd></dl>
<p>Reimplemented from <a class="el" href="classgeos_1_1geom_1_1LineString.html#af69a9f8d665c21ac957816fb5b95a4a1">geos::geom::LineString</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LinearRing_8h_source.html">LinearRing.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>
