LineString.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2011 Sandro Santilli <strk@keybit.net>
 * Copyright (C) 2001-2002 Vivid Solutions Inc.
 * Copyright (C) 2005 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.
 *
 **********************************************************************
 *
 * Last port: geom/LineString.java r320 (JTS-1.12)
 *
 **********************************************************************/
 
#ifndef GEOS_GEOS_LINESTRING_H
#define GEOS_GEOS_LINESTRING_H
 
#include <geos/export.h>
#include <geos/platform.h> // do we need this ?
#include <geos/geom/Geometry.h> // for inheritance
#include <geos/geom/Lineal.h> // for inheritance
#include <geos/geom/CoordinateSequence.h> // for proper use of auto_ptr<>
#include <geos/geom/Envelope.h> // for proper use of auto_ptr<>
#include <geos/geom/Dimension.h> // for Dimension::DimensionType
 
#include <string>
#include <vector>
#include <memory> // for auto_ptr
 
#include <geos/inline.h>
 
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251) // warning C4251: needs to have dll-interface to be used by clients of class
#endif
 
namespace geos {
        namespace geom {
                class Coordinate;
                class CoordinateArraySequence;
                class CoordinateSequenceFilter;
        }
}
 
namespace geos {
namespace geom { // geos::geom

class GEOS_DLL LineString: public virtual Geometry, public Lineal {
 
public:
 
        friend class GeometryFactory;

        typedef std::vector<const LineString *> ConstVect;
 
        virtual ~LineString();

        virtual Geometry *clone() const;
 
        virtual CoordinateSequence* getCoordinates() const;

        const CoordinateSequence* getCoordinatesRO() const;
 
        virtual const Coordinate& getCoordinateN(int n) const;

        virtual Dimension::DimensionType getDimension() const;

        virtual int getBoundaryDimension() const;

        virtual int getCoordinateDimension() const;

        virtual Geometry* getBoundary() const;
 
        virtual bool isEmpty() const;
 
        virtual std::size_t getNumPoints() const;
 
        virtual Point* getPointN(std::size_t n) const;

        virtual Point* getStartPoint() const;

        virtual Point* getEndPoint() const;
 
        virtual bool isClosed() const;
 
        virtual bool isRing() const;
 
        virtual std::string getGeometryType() const;
 
        virtual GeometryTypeId getGeometryTypeId() const;
 
        virtual bool isCoordinate(Coordinate& pt) const;
 
        virtual bool equalsExact(const Geometry *other, double tolerance=0)
                const;
 
        virtual void apply_rw(const CoordinateFilter *filter);
 
        virtual void apply_ro(CoordinateFilter *filter) const;
 
        virtual void apply_rw(GeometryFilter *filter);
 
        virtual void apply_ro(GeometryFilter *filter) const;
 
        virtual void apply_rw(GeometryComponentFilter *filter);
 
        virtual void apply_ro(GeometryComponentFilter *filter) const;
 
        void apply_rw(CoordinateSequenceFilter& filter);
 
        void apply_ro(CoordinateSequenceFilter& filter) const;

        virtual void normalize();
 
        //was protected
        virtual int compareToSameClass(const Geometry *ls) const;
 
        virtual const Coordinate* getCoordinate() const;
 
        virtual double getLength() const;

        Geometry* reverse() const;
 
protected:
 
        LineString(const LineString &ls);

        LineString(CoordinateSequence *pts, const GeometryFactory *newFactory);

        LineString(CoordinateSequence::AutoPtr pts,
                        const GeometryFactory *newFactory);
 
        Envelope::AutoPtr computeEnvelopeInternal() const;
 
        CoordinateSequence::AutoPtr points;
 
private:
 
        void validateConstruction();
 
};
 
struct GEOS_DLL  LineStringLT {
        bool operator()(const LineString *ls1, const LineString *ls2) const {
                return ls1->compareTo(ls2)<0;
        }
};
 
 
inline Geometry*
LineString::clone() const {
        return new LineString(*this);
}
 
} // namespace geos::geom
} // namespace geos
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif // ndef GEOS_GEOS_LINESTRING_H