CoordinateSequence.h

/**********************************************************************
 * $Id: CoordinateSequence.h 2556 2009-06-06 22:22:28Z strk $
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.refractions.net
 *
 * Copyright (C) 2006 Refractions Research Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation. 
 * See the COPYING file for more information.
 *
 **********************************************************************/

#ifndef GEOS_GEOM_COORDINATESEQUENCE_H
#define GEOS_GEOM_COORDINATESEQUENCE_H

#include <geos/export.h>
#include <geos/platform.h>
#include <geos/inline.h>

#include <geos/geom/Coordinate.h> // for applyCoordinateFilter

#include <vector>
#include <iosfwd> // ostream
#include <memory> // for auto_ptr typedef

// Forward declarations
namespace geos {
        namespace geom { 
                class Envelope;
                class CoordinateFilter;
                class Coordinate;
        }
}


namespace geos {
namespace geom { // geos::geom

class GEOS_DLL CoordinateSequence {

protected:

        CoordinateSequence() {}

        CoordinateSequence(const CoordinateSequence&) {}

public:

        typedef std::auto_ptr<CoordinateSequence> AutoPtr;

        friend std::ostream& operator<< (std::ostream& os,
                const CoordinateSequence& cs);

        friend bool operator== (
                const CoordinateSequence& seq1,
                const CoordinateSequence& seq2);

        friend bool operator!= (
                const CoordinateSequence& seq1,
                const CoordinateSequence& seq2);

        virtual ~CoordinateSequence() {}

        virtual CoordinateSequence *clone() const=0;

        //virtual const Coordinate& getCoordinate(int i) const=0;
        virtual const Coordinate& getAt(size_t i) const=0;

        const Coordinate& back() const {
                return getAt(size()-1);
        }

        const Coordinate& front() const {
                return getAt(0);
        }

        const Coordinate& operator[] (size_t i) const {
                return getAt(i);
        }

        virtual void getAt(size_t i, Coordinate& c) const=0;

        //virtual int size() const=0;
        virtual size_t getSize() const=0;

        size_t size() const { return getSize(); }

        virtual const std::vector<Coordinate>* toVector() const=0;

        void add(const std::vector<Coordinate>* vc, bool allowRepeated);

        /* This is here for backward compatibility.. */
        //void add(CoordinateSequence *cl,bool allowRepeated,bool direction);

        void add(const CoordinateSequence *cl, bool allowRepeated,
                        bool direction);

        virtual void add(const Coordinate& c, bool allowRepeated);

        virtual void add(size_t i, const Coordinate& coord, bool allowRepeated)=0;

        virtual bool isEmpty() const=0;

        virtual void add(const Coordinate& c)=0;

        // Get number of coordinates
        //virtual int getSize() const=0;

        //virtual       const Coordinate& getAt(size_t pos) const=0;

        virtual void setAt(const Coordinate& c, size_t pos)=0;

        virtual void deleteAt(size_t pos)=0;

        virtual std::string toString() const=0;

        virtual void setPoints(const std::vector<Coordinate> &v)=0;
        
        bool hasRepeatedPoints() const;

        const Coordinate* minCoordinate() const;


        static CoordinateSequence* removeRepeatedPoints(
                        const CoordinateSequence *cl);

        //
        virtual CoordinateSequence& removeRepeatedPoints()=0;

        static bool hasRepeatedPoints(const CoordinateSequence *cl);

        static CoordinateSequence* atLeastNCoordinatesOrNothing(size_t n,
                        CoordinateSequence *c);

        static const Coordinate* minCoordinate(CoordinateSequence *cl);

        //
        static int indexOf(const Coordinate *coordinate,
                        const CoordinateSequence *cl);

        static bool equals(const CoordinateSequence *cl1,
                        const CoordinateSequence *cl2);

        static void scroll(CoordinateSequence *cl, const Coordinate *firstCoordinate);

        static int increasingDirection(const CoordinateSequence& pts);

        static void reverse(CoordinateSequence *cl);

        enum { X,Y,Z,M };

        virtual size_t getDimension() const=0;

        virtual double getOrdinate(size_t index, size_t ordinateIndex) const=0;

        virtual double getX(size_t index) const { return getOrdinate(index, X); }

        virtual double getY(size_t index) const { return getOrdinate(index, Y); }


        virtual void setOrdinate(size_t index, size_t ordinateIndex, double value)=0;

        virtual void expandEnvelope(Envelope &env) const;

        virtual void apply_rw(const CoordinateFilter *filter)=0; //Abstract
        virtual void apply_ro(CoordinateFilter *filter) const=0; //Abstract

        template <class T>
        void applyCoordinateFilter(T& f) 
        {
                Coordinate c;
                for(size_t i=0, n=size(); i<n; ++i)
                {
                        getAt(i, c);
                        f.filter(c);
                        setAt(c, i);
                }
        }

};

std::ostream& operator<< (std::ostream& os, const CoordinateSequence& cs);

bool operator== (const CoordinateSequence& s1, const CoordinateSequence& s2);

bool operator!= (const CoordinateSequence& s1, const CoordinateSequence& s2);

} // namespace geos::geom
} // namespace geos

//#ifdef GEOS_INLINE
//# include "geos/geom/CoordinateSequence.inl"
//#endif

#endif // ndef GEOS_GEOM_COORDINATESEQUENCE_H

/**********************************************************************
 * $Log$
 * Revision 1.12  2006/06/12 16:51:23  strk
 * Added equality and inequality operators and tests
 *
 * Revision 1.11  2006/06/12 16:36:22  strk
 * indentation, notes about things to be fixed.
 *
 * Revision 1.10  2006/06/12 15:06:30  strk
 * Added default ctor and copy ctor (protected)
 *
 * Revision 1.9  2006/06/12 10:10:39  strk
 * Fixed getGeometryN() to take size_t rather then int, changed unsigned int parameters to size_t.
 *
 * Revision 1.8  2006/05/04 08:42:12  strk
 * Added note about the CoordinateSequence::toVector() method.
 *
 * Revision 1.7  2006/05/03 19:47:27  strk
 * added operator<< for CoordinateSequence
 *
 * Revision 1.6  2006/05/03 08:58:34  strk
 * added new non-static CoordinateSequence::removeRepeatedPoints() mutator.
 *
 * Revision 1.5  2006/04/11 11:55:22  strk
 * Added CoordinateSequence::AutoPtr typedef
 *
 * Revision 1.4  2006/04/04 09:53:45  strk
 * Fixed applyCoordinateFilter() templated function body
 *
 * Revision 1.3  2006/03/24 09:52:41  strk
 * USE_INLINE => GEOS_INLINE
 *
 * Revision 1.2  2006/03/20 17:27:03  strk
 * Bug #72 - Missing <vector> header
 *
 * Revision 1.1  2006/03/09 16:46:49  strk
 * geos::geom namespace definition, first pass at headers split
 *
 **********************************************************************/

---