<!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: LineString.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>LineString.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * $Id: LineString.h 2556 2009-06-06 22:22:28Z strk $</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * GEOS - Geometry Engine Open Source</span>
<a name="l00005"></a>00005 <span class="comment"> * http://geos.refractions.net</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2001-2002 Vivid Solutions Inc.</span>
<a name="l00008"></a>00008 <span class="comment"> * Copyright (C) 2005 2006 Refractions Research Inc.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This is free software; you can redistribute and/or modify it under</span>
<a name="l00011"></a>00011 <span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span>
<a name="l00012"></a>00012 <span class="comment"> * by the Free Software Foundation. </span>
<a name="l00013"></a>00013 <span class="comment"> * See the COPYING file for more information.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> **********************************************************************</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * Last port: geom/LineString.java rev. 1.46</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> **********************************************************************/</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef GEOS_GEOS_LINESTRING_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define GEOS_GEOS_LINESTRING_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <geos/export.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <geos/platform.h></span> <span class="comment">// do we need this ?</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <geos/geom/Geometry.h></span> <span class="comment">// for inheritance</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <geos/geom/CoordinateSequence.h></span> <span class="comment">// for proper use of auto_ptr<></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <geos/geom/Envelope.h></span> <span class="comment">// for proper use of auto_ptr<></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <geos/geom/Dimension.h></span> <span class="comment">// for Dimension::DimensionType</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include <string></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <vector></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <memory></span> <span class="comment">// for auto_ptr</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#include <geos/inline.h></span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>geos {
<a name="l00038"></a>00038 <span class="keyword">namespace </span>geom {
<a name="l00039"></a>00039 <span class="keyword">class </span>Coordinate;
<a name="l00040"></a>00040 <span class="keyword">class </span>CoordinateArraySequence;
<a name="l00041"></a>00041 <span class="keyword">class </span>CoordinateSequenceFilter;
<a name="l00042"></a>00042 }
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">namespace </span>geos {
<a name="l00046"></a>00046 <span class="keyword">namespace </span>geom { <span class="comment">// geos::geom</span>
<a name="l00047"></a>00047
<a name="l00052"></a><a class="code" href="classgeos_1_1geom_1_1LineString.html">00052</a> <span class="keyword">class </span>GEOS_DLL <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>: <span class="keyword">public</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> {
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" 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>;
<a name="l00057"></a>00057
<a name="l00059"></a><a class="code" href="classgeos_1_1geom_1_1LineString.html#aa165bf9c81c16f6b7934804bcdbbcd4f">00059</a> <span class="keyword">typedef</span> std::vector<const LineString *> ConstVect;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">virtual</span> ~<a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>();
<a name="l00062"></a>00062
<a name="l00069"></a>00069 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> *clone() <span class="keyword">const</span>;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a>* getCoordinates() <span class="keyword">const</span>;
<a name="l00072"></a>00072
<a name="l00074"></a>00074 <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a>* getCoordinatesRO() <span class="keyword">const</span>;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a>& getCoordinateN(<span class="keywordtype">int</span> n) <span class="keyword">const</span>;
<a name="l00077"></a>00077
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Dimension.html#af46f1c0c325eb685fcf32987748d04cf">Dimension::DimensionType</a> getDimension() <span class="keyword">const</span>;
<a name="l00080"></a>00080
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getBoundaryDimension() <span class="keyword">const</span>;
<a name="l00087"></a>00087
<a name="l00093"></a>00093 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a>* getBoundary() <span class="keyword">const</span>;
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isEmpty() <span class="keyword">const</span>;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getNumPoints() <span class="keyword">const</span>;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Point.html" title="Basic implementation of Point.">Point</a>* getPointN(<span class="keywordtype">size_t</span> n) <span class="keyword">const</span>;
<a name="l00100"></a>00100
<a name="l00105"></a>00105 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Point.html" title="Basic implementation of Point.">Point</a>* getStartPoint() <span class="keyword">const</span>;
<a name="l00106"></a>00106
<a name="l00111"></a>00111 <span class="keyword">virtual</span> <a class="code" href="classgeos_1_1geom_1_1Point.html" title="Basic implementation of Point.">Point</a>* getEndPoint() <span class="keyword">const</span>;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isClosed() <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isRing() <span class="keyword">const</span>;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">virtual</span> std::string getGeometryType() <span class="keyword">const</span>;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keyword">virtual</span> <a class="code" href="namespacegeos_1_1geom.html#a98c5b0e81001a7c3fdc7a058960356d8" title="Geometry types.">GeometryTypeId</a> getGeometryTypeId() <span class="keyword">const</span>;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isCoordinate(<a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a>& pt) <span class="keyword">const</span>;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equalsExact(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> *other, <span class="keywordtype">double</span> tolerance=0)
<a name="l00124"></a>00124 <span class="keyword">const</span>;
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_rw(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1CoordinateFilter.html">CoordinateFilter</a> *filter);
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_ro(<a class="code" href="classgeos_1_1geom_1_1CoordinateFilter.html">CoordinateFilter</a> *filter) <span class="keyword">const</span>;
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_rw(<a class="code" href="classgeos_1_1geom_1_1GeometryFilter.html" title="Geometry classes support the concept of applying a Geometry filter to the Geometry.">GeometryFilter</a> *filter);
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_ro(<a class="code" href="classgeos_1_1geom_1_1GeometryFilter.html" title="Geometry classes support the concept of applying a Geometry filter to the Geometry.">GeometryFilter</a> *filter) <span class="keyword">const</span>;
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_rw(<a class="code" href="classgeos_1_1geom_1_1GeometryComponentFilter.html">GeometryComponentFilter</a> *filter);
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply_ro(<a class="code" href="classgeos_1_1geom_1_1GeometryComponentFilter.html">GeometryComponentFilter</a> *filter) <span class="keyword">const</span>;
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="keywordtype">void</span> apply_rw(<a class="code" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html">CoordinateSequenceFilter</a>& filter);
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordtype">void</span> apply_ro(<a class="code" href="classgeos_1_1geom_1_1CoordinateSequenceFilter.html">CoordinateSequenceFilter</a>& filter) <span class="keyword">const</span>;
<a name="l00141"></a>00141
<a name="l00149"></a>00149 <span class="keyword">virtual</span> <span class="keywordtype">void</span> normalize();
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="comment">//was protected</span>
<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">int</span> compareToSameClass(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> *ls) <span class="keyword">const</span>;
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">Coordinate</a>* getCoordinate() <span class="keyword">const</span>;
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">double</span> getLength() <span class="keyword">const</span>;
<a name="l00157"></a>00157
<a name="l00164"></a>00164 <a class="code" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a>* reverse() <span class="keyword">const</span>;
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="keyword">protected</span>:
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> &ls);
<a name="l00169"></a>00169
<a name="l00173"></a>00173 <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>(<a class="code" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry.">CoordinateSequence</a> *pts, <span class="keyword">const</span> <a class="code" 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> *newFactory);
<a name="l00174"></a>00174
<a name="l00176"></a>00176 <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>(CoordinateSequence::AutoPtr pts,
<a name="l00177"></a>00177 <span class="keyword">const</span> <a class="code" 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> *newFactory);
<a name="l00178"></a>00178
<a name="l00179"></a>00179 Envelope::AutoPtr computeEnvelopeInternal() <span class="keyword">const</span>;
<a name="l00180"></a>00180
<a name="l00181"></a>00181 CoordinateSequence::AutoPtr points;
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keyword">private</span>:
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keywordtype">void</span> validateConstruction();
<a name="l00186"></a>00186
<a name="l00187"></a>00187 };
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="keyword">struct </span>GEOS_DLL LineStringLT {
<a name="l00190"></a>00190 <span class="keywordtype">bool</span> operator()(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> *ls1, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a> *ls2)<span class="keyword"> const </span>{
<a name="l00191"></a>00191 <span class="keywordflow">return</span> ls1->compareTo(ls2)<0;
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193 };
<a name="l00194"></a>00194
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="keyword">inline</span> Geometry*
<a name="l00197"></a><a class="code" href="classgeos_1_1geom_1_1LineString.html#aebd169c82f9a33b8e8ac9b2664eaab79">00197</a> <a class="code" href="classgeos_1_1geom_1_1LineString.html#aebd169c82f9a33b8e8ac9b2664eaab79">LineString::clone</a>()<span class="keyword"> const </span>{
<a name="l00198"></a>00198 <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a>(*<span class="keyword">this</span>);
<a name="l00199"></a>00199 }
<a name="l00200"></a>00200
<a name="l00201"></a>00201 } <span class="comment">// namespace geos::geom</span>
<a name="l00202"></a>00202 } <span class="comment">// namespace geos</span>
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="comment">//#ifdef GEOS_INLINE</span>
<a name="l00205"></a>00205 <span class="comment">//# include "geos/geom/LineString.inl"</span>
<a name="l00206"></a>00206 <span class="comment">//#endif</span>
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="preprocessor">#endif // ndef GEOS_GEOS_LINESTRING_H</span>
<a name="l00209"></a>00209 <span class="preprocessor"></span>
<a name="l00210"></a>00210 <span class="comment">/**********************************************************************</span>
<a name="l00211"></a>00211 <span class="comment"> * $Log$</span>
<a name="l00212"></a>00212 <span class="comment"> * Revision 1.10 2006/06/12 10:49:43 strk</span>
<a name="l00213"></a>00213 <span class="comment"> * unsigned int => size_t</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * Revision 1.9 2006/05/04 15:49:39 strk</span>
<a name="l00216"></a>00216 <span class="comment"> * updated all Geometry::getDimension() methods to return Dimension::DimensionType (closes bug#93)</span>
<a name="l00217"></a>00217 <span class="comment"> *</span>
<a name="l00218"></a>00218 <span class="comment"> * Revision 1.8 2006/04/28 10:55:39 strk</span>
<a name="l00219"></a>00219 <span class="comment"> * Geometry constructors made protected, to ensure all constructions use GeometryFactory,</span>
<a name="l00220"></a>00220 <span class="comment"> * which has been made friend of all Geometry derivates. getNumPoints() changed to return</span>
<a name="l00221"></a>00221 <span class="comment"> * size_t.</span>
<a name="l00222"></a>00222 <span class="comment"> *</span>
<a name="l00223"></a>00223 <span class="comment"> * Revision 1.7 2006/04/11 11:16:25 strk</span>
<a name="l00224"></a>00224 <span class="comment"> * Added LineString and LinearRing constructors by auto_ptr</span>
<a name="l00225"></a>00225 <span class="comment"> *</span>
<a name="l00226"></a>00226 <span class="comment"> * Revision 1.6 2006/04/10 18:15:09 strk</span>
<a name="l00227"></a>00227 <span class="comment"> * Changed Geometry::envelope member to be of type auto_ptr<Envelope>.</span>
<a name="l00228"></a>00228 <span class="comment"> * Changed computeEnvelopeInternal() signater to return auto_ptr<Envelope></span>
<a name="l00229"></a>00229 <span class="comment"> *</span>
<a name="l00230"></a>00230 <span class="comment"> * Revision 1.5 2006/04/10 17:35:44 strk</span>
<a name="l00231"></a>00231 <span class="comment"> * Changed LineString::points and Point::coordinates to be wrapped</span>
<a name="l00232"></a>00232 <span class="comment"> * in an auto_ptr<>. This should close bugs #86 and #89</span>
<a name="l00233"></a>00233 <span class="comment"> *</span>
<a name="l00234"></a>00234 <span class="comment"> * Revision 1.4 2006/04/05 10:25:21 strk</span>
<a name="l00235"></a>00235 <span class="comment"> * Fixed LineString constructor to ensure deletion of CoordinateSequence</span>
<a name="l00236"></a>00236 <span class="comment"> * argument on exception throw</span>
<a name="l00237"></a>00237 <span class="comment"> *</span>
<a name="l00238"></a>00238 <span class="comment"> * Revision 1.3 2006/03/31 16:55:17 strk</span>
<a name="l00239"></a>00239 <span class="comment"> * Added many assertions checking in LineString implementation.</span>
<a name="l00240"></a>00240 <span class="comment"> * Changed ::getCoordinate() to return NULL on empty geom.</span>
<a name="l00241"></a>00241 <span class="comment"> * Changed ::get{Start,End}Point() to return NULL on empty geom.</span>
<a name="l00242"></a>00242 <span class="comment"> *</span>
<a name="l00243"></a>00243 <span class="comment"> * Revision 1.2 2006/03/24 09:52:41 strk</span>
<a name="l00244"></a>00244 <span class="comment"> * USE_INLINE => GEOS_INLINE</span>
<a name="l00245"></a>00245 <span class="comment"> *</span>
<a name="l00246"></a>00246 <span class="comment"> * Revision 1.1 2006/03/09 16:46:49 strk</span>
<a name="l00247"></a>00247 <span class="comment"> * geos::geom namespace definition, first pass at headers split</span>
<a name="l00248"></a>00248 <span class="comment"> *</span>
<a name="l00249"></a>00249 <span class="comment"> **********************************************************************/</span>
</pre></div></div>
</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>
