<!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::distance::GeometryLocation 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_1distance.html">distance</a> </li>
<li><a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html">geos::operation::distance::GeometryLocation</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<h1>geos::operation::distance::GeometryLocation Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::operation::distance::GeometryLocation" -->
<p>Represents the location of a point on a Geometry.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="GeometryLocation_8h_source.html">GeometryLocation.h</a>></code></p>
<p><a href="classgeos_1_1operation_1_1distance_1_1GeometryLocation-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_1distance_1_1GeometryLocation.html#aa15571af12de67ae48d9611150e480aa">GeometryLocation</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *component, int segIndex, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &pt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html" title="Represents the location of a point on a Geometry.">GeometryLocation</a> specifying a point on a geometry, as well as the segment that the point is on (or INSIDE_AREA if the point is not on a segment). <a href="#aa15571af12de67ae48d9611150e480aa"></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_1distance_1_1GeometryLocation.html#a2a8a5da646f71879fd1057e15accd0b0">GeometryLocation</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *component, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &pt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html" title="Represents the location of a point on a Geometry.">GeometryLocation</a> specifying a point inside an area geometry. <a href="#a2a8a5da646f71879fd1057e15accd0b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html#a135e6881b11544534f74557bcfd4969e">getGeometryComponent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html#a3f067cceee1b0b9a7f327588fa180db5">getSegmentIndex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><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_1distance_1_1GeometryLocation.html#a11f79bfd8c2e9ae486539bcd81f8ed79">getCoordinate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e9adb9f67c51ec5cae73f64767cdf72"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::isInsideArea" ref="a9e9adb9f67c51ec5cae73f64767cdf72" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html#a9e9adb9f67c51ec5cae73f64767cdf72">isInsideArea</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests whether this location represents a point inside an area geometry. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html#ad32593dce7434a63b2ef69214c04a353">INSIDE_AREA</a> = -1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A Special value of segmentIndex used for locations inside area geometries. <a href="#ad32593dce7434a63b2ef69214c04a353"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents the location of a point on a Geometry. </p>
<p>Maintains both the actual point location (which may not be exact, if the point is not a vertex) as well as information about the component and segment index where the point occurs. Locations inside area Geometrys will not have an associated segment index, so in this case the segment index will have the sentinel value of INSIDE_AREA. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa15571af12de67ae48d9611150e480aa"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::GeometryLocation" ref="aa15571af12de67ae48d9611150e480aa" args="(const geom::Geometry *component, int segIndex, const geom::Coordinate &pt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::distance::GeometryLocation::GeometryLocation </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>component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>segIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
<td class="paramname"> <em>pt</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 <a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html" title="Represents the location of a point on a Geometry.">GeometryLocation</a> specifying a point on a geometry, as well as the segment that the point is on (or INSIDE_AREA if the point is not on a segment). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>component</em> </td><td>the component of the geometry containing the point </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segIndex</em> </td><td>the segment index of the location, or INSIDE_AREA </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pt</em> </td><td>the coordinate of the location </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a8a5da646f71879fd1057e15accd0b0"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::GeometryLocation" ref="a2a8a5da646f71879fd1057e15accd0b0" args="(const geom::Geometry *component, const geom::Coordinate &pt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::operation::distance::GeometryLocation::GeometryLocation </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>component</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
<td class="paramname"> <em>pt</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 <a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html" title="Represents the location of a point on a Geometry.">GeometryLocation</a> specifying a point inside an area geometry. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>component</em> </td><td>the component of the geometry containing the point </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pt</em> </td><td>the coordinate of the location </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a11f79bfd8c2e9ae486539bcd81f8ed79"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::getCoordinate" ref="a11f79bfd8c2e9ae486539bcd81f8ed79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>& geos::operation::distance::GeometryLocation::getCoordinate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">geom::Coordinate</a> of this location. </p>
</div>
</div>
<a class="anchor" id="a135e6881b11544534f74557bcfd4969e"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::getGeometryComponent" ref="a135e6881b11544534f74557bcfd4969e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>* geos::operation::distance::GeometryLocation::getGeometryComponent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the geometry component on (or in) which this location occurs. </p>
</div>
</div>
<a class="anchor" id="a3f067cceee1b0b9a7f327588fa180db5"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::getSegmentIndex" ref="a3f067cceee1b0b9a7f327588fa180db5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int geos::operation::distance::GeometryLocation::getSegmentIndex </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the segment index for this location.</p>
<p>If the location is inside an area, the index will have the value INSIDE_AREA;</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the segment index for the location, or INSIDE_AREA </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ad32593dce7434a63b2ef69214c04a353"></a><!-- doxytag: member="geos::operation::distance::GeometryLocation::INSIDE_AREA" ref="ad32593dce7434a63b2ef69214c04a353" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classgeos_1_1operation_1_1distance_1_1GeometryLocation.html#ad32593dce7434a63b2ef69214c04a353">geos::operation::distance::GeometryLocation::INSIDE_AREA</a> = -1<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A Special value of segmentIndex used for locations inside area geometries. </p>
<p>These locations are not located on a segment, and thus do not have an associated segment index. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="GeometryLocation_8h_source.html">GeometryLocation.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>
