include/geos/geom/CoordinateArraySequence.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_COORDINATEARRAYSEQUENCE_H
  16 #define GEOS_GEOM_COORDINATEARRAYSEQUENCE_H
  17
  18 #include <geos/export.h>
  19 #include <vector>
  20
  21 #include <geos/geom/CoordinateSequence.h>
  22
  23 #include <geos/inline.h>
  24
  25 // Forward declarations
  26 namespace geos {
  27         namespace geom {
  28                 class Coordinate;
  29         }
  30 }
  31
  32
  33 namespace geos {
  34 namespace geom { // geos.geom
  35
  36 /// The default implementation of CoordinateSequence
  37 class GEOS_DLL CoordinateArraySequence : public CoordinateSequence {
  38 public:
  39
  40     CoordinateArraySequence(const CoordinateArraySequence &cl);
  41
  42         CoordinateSequence *clone() const;
  43
  44         //const Coordinate& getCoordinate(int pos) const;
  45         const Coordinate& getAt(std::size_t pos) const;
  46
  47         /// Copy Coordinate at position i to Coordinate c
  48         virtual void getAt(std::size_t i, Coordinate& c) const;
  49
  50         //int size() const;
  51         size_t getSize() const;
  52
  53         // @deprecated
  54         const std::vector<Coordinate>* toVector() const;
  55
  56         // See dox in CoordinateSequence.h
  57         void toVector(std::vector<Coordinate>&) const;
  58
  59         /// Construct an empty sequence
  60         CoordinateArraySequence();
  61
  62         /// Construct sequence taking ownership of given Coordinate vector
  63         CoordinateArraySequence(std::vector<Coordinate> *coords,
  64                                 std::size_t dimension = 0);
  65
  66         /// Construct sequence allocating space for n coordinates
  67         CoordinateArraySequence(std::size_t n, std::size_t dimension = 0);
  68
  69         ~CoordinateArraySequence();
  70
  71         bool isEmpty() const { return empty(); }
  72
  73         bool empty() const { return vect->empty(); }
  74
  75         /// Reset this CoordinateArraySequence to the empty state
  76         void clear() { vect->clear(); }
  77
  78         void add(const Coordinate& c);
  79
  80         virtual void add(const Coordinate& c, bool allowRepeated);
  81
  82         /** \brief
  83          * Inserts the specified coordinate at the specified position in
  84          * this list.
  85          *
  86          * @param i the position at which to insert
  87          * @param coord the coordinate to insert
  88          * @param allowRepeated if set to false, repeated coordinates are
  89          *                      collapsed
  90          *
  91          * NOTE: this is a CoordinateList interface in JTS
  92          */
  93         virtual void add(std::size_t i, const Coordinate& coord, bool allowRepeated);
  94
  95         void setAt(const Coordinate& c, std::size_t pos);
  96
  97         void deleteAt(std::size_t pos);
  98
  99         std::string toString() const;
 100
 101         void setPoints(const std::vector<Coordinate> &v);
 102
 103         double getOrdinate(std::size_t index,
 104                         size_t ordinateIndex) const;
 105
 106         void setOrdinate(std::size_t index, std::size_t ordinateIndex,
 107                         double value);
 108
 109         void expandEnvelope(Envelope &env) const;
 110
 111     std::size_t getDimension() const;
 112
 113         void apply_rw(const CoordinateFilter *filter);
 114
 115         void apply_ro(CoordinateFilter *filter) const;
 116
 117         virtual CoordinateSequence& removeRepeatedPoints();
 118
 119 private:
 120         std::vector<Coordinate> *vect;
 121     mutable std::size_t dimension;
 122 };
 123
 124 /// This is for backward API compatibility
 125 typedef CoordinateArraySequence DefaultCoordinateSequence;
 126
 127 } // namespace geos.geom
 128 } // namespace geos
 129
 130 //#ifdef GEOS_INLINE
 131 //# include "geos/geom/CoordinateArraySequence.inl"
 132 //#endif
 133
 134 #endif // ndef GEOS_GEOM_COORDINATEARRAYSEQUENCE_H
 135
 136 /**********************************************************************
 137  * $Log$
 138  * Revision 1.4  2006/06/12 10:10:39  strk
 139  * Fixed getGeometryN() to take size_t rather then int, changed unsigned int parameters to size_t.
 140  *
 141  * Revision 1.3  2006/05/03 08:58:34  strk
 142  * added new non-static CoordinateSequence::removeRepeatedPoints() mutator.
 143  *
 144  * Revision 1.2  2006/03/24 09:52:41  strk
 145  * USE_INLINE => GEOS_INLINE
 146  *
 147  * Revision 1.1  2006/03/09 16:46:49  strk
 148  * geos::geom namespace definition, first pass at headers split
 149  *
 150  **********************************************************************/