GEOS  3.9.0dev
CoordinateSequence.h
1 /**********************************************************************
2  *
3  * GEOS - Geometry Engine Open Source
4  * http://geos.osgeo.org
5  *
6  * Copyright (C) 2006 Refractions Research Inc.
7  *
8  * This is free software; you can redistribute and/or modify it under
9  * the terms of the GNU Lesser General Public Licence as published
10  * by the Free Software Foundation.
11  * See the COPYING file for more information.
12  *
13  **********************************************************************/
14 
15 #ifndef GEOS_GEOM_COORDINATESEQUENCE_H
16 #define GEOS_GEOM_COORDINATESEQUENCE_H
17 
18 #include <geos/export.h>
19 #include <geos/inline.h>
20 
21 #include <geos/geom/Coordinate.h> // for applyCoordinateFilter
22 
23 #include <vector>
24 #include <iosfwd> // ostream
25 #include <memory> // for unique_ptr typedef
26 
27 // Forward declarations
28 namespace geos {
29 namespace geom {
30 class Envelope;
31 class CoordinateFilter;
32 class Coordinate;
33 }
34 }
35 
36 namespace geos {
37 namespace geom { // geos::geom
38 
58 class GEOS_DLL CoordinateSequence {
59 
60 protected:
61 
63 
65 
66 public:
67 
68  typedef std::unique_ptr<CoordinateSequence> Ptr;
69 
70  virtual
71  ~CoordinateSequence() {}
72 
76  virtual std::unique_ptr<CoordinateSequence> clone() const = 0;
77 
84  virtual const Coordinate& getAt(std::size_t i) const = 0;
85 
87  const Coordinate&
88  back() const
89  {
90  return getAt(size() - 1);
91  }
92 
94  const Coordinate&
95  front() const
96  {
97  return getAt(0);
98  }
99 
100  const Coordinate&
101  operator[](std::size_t i) const
102  {
103  return getAt(i);
104  }
105 
106  virtual Envelope getEnvelope() const;
107 
111  virtual void getAt(std::size_t i, Coordinate& c) const = 0;
112 
117  virtual std::size_t getSize() const = 0;
118 
119  size_t
120  size() const
121  {
122  return getSize();
123  }
124 
129  virtual void toVector(std::vector<Coordinate>& coords) const = 0;
130 
132  virtual bool isEmpty() const = 0;
133 
135  virtual void setAt(const Coordinate& c, std::size_t pos) = 0;
136 
138  std::string toString() const;
139 
141  virtual void setPoints(const std::vector<Coordinate>& v) = 0;
142 
144  bool hasRepeatedPoints() const;
145 
147  const Coordinate* minCoordinate() const;
148 
153  static bool hasRepeatedPoints(const CoordinateSequence* cl);
154 
159  static CoordinateSequence* atLeastNCoordinatesOrNothing(std::size_t n,
160  CoordinateSequence* c);
161 
167  static size_t indexOf(const Coordinate* coordinate,
168  const CoordinateSequence* cl);
169 
175  static bool equals(const CoordinateSequence* cl1,
176  const CoordinateSequence* cl2);
177 
179  static void scroll(CoordinateSequence* cl, const Coordinate* firstCoordinate);
180 
198  static int increasingDirection(const CoordinateSequence& pts);
199 
200 
209  static bool isRing(const CoordinateSequence *pts);
210 
212  static void reverse(CoordinateSequence* cl);
213 
215  enum { X, Y, Z, M };
216 
223  virtual std::size_t getDimension() const = 0;
224 
235  virtual double getOrdinate(std::size_t index, std::size_t ordinateIndex) const;
236 
243  virtual double
244  getX(std::size_t index) const
245  {
246  return getOrdinate(index, X);
247  }
248 
255  virtual double
256  getY(std::size_t index) const
257  {
258  return getOrdinate(index, Y);
259  }
260 
261 
270  virtual void setOrdinate(std::size_t index, std::size_t ordinateIndex, double value) = 0;
271 
279  virtual void expandEnvelope(Envelope& env) const;
280 
281  virtual void apply_rw(const CoordinateFilter* filter) = 0; //Abstract
282  virtual void apply_ro(CoordinateFilter* filter) const = 0; //Abstract
283 
292  template <class T>
293  void
295  {
296  Coordinate c;
297  for(std::size_t i = 0, n = size(); i < n; ++i) {
298  getAt(i, c);
299  f.filter(c);
300  setAt(c, i);
301  }
302  }
303 
304 };
305 
306 GEOS_DLL std::ostream& operator<< (std::ostream& os, const CoordinateSequence& cs);
307 
308 GEOS_DLL bool operator== (const CoordinateSequence& s1, const CoordinateSequence& s2);
309 
310 GEOS_DLL bool operator!= (const CoordinateSequence& s1, const CoordinateSequence& s2);
311 
312 } // namespace geos::geom
313 } // namespace geos
314 
315 //#ifdef GEOS_INLINE
316 //# include "geos/geom/CoordinateSequence.inl"
317 //#endif
318 
319 #endif // ndef GEOS_GEOM_COORDINATESEQUENCE_H
void applyCoordinateFilter(T &f)
Apply a filter to each Coordinate of this sequence. The filter is expected to provide a ...
Definition: CoordinateSequence.h:294
An Envelope defines a rectangulare region of the 2D coordinate plane.
Definition: Envelope.h:58
Coordinate is the lightweight class used to store coordinates.
Definition: Coordinate.h:60
const Coordinate & back() const
Return last Coordinate in the sequence.
Definition: CoordinateSequence.h:88
virtual double getY(std::size_t index) const
Definition: CoordinateSequence.h:256
Geometry classes support the concept of applying a coordinate filter to every coordinate in the Geome...
Definition: CoordinateFilter.h:43
std::ostream & operator<<(std::ostream &os, const Coordinate &c)
Output function.
Basic namespace for all GEOS functionalities.
Definition: IndexedNestedRingTester.h:26
bool operator!=(const Coordinate &a, const Coordinate &b)
Inequality operator for Coordinate. 2D only.
The internal representation of a list of coordinates inside a Geometry.
Definition: CoordinateSequence.h:58
bool operator==(const Coordinate &a, const Coordinate &b)
Equality operator for Coordinate. 2D only.
virtual double getX(std::size_t index) const
Definition: CoordinateSequence.h:244
const Coordinate & front() const
Return first Coordinate in the sequence.
Definition: CoordinateSequence.h:95