Coordinate.h

Go to the documentation of this file.

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * 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_COORDINATE_H
#define GEOS_GEOM_COORDINATE_H

#include <geos/export.h>
#include <geos/constants.h> // for DoubleNotANumber
#include <geos/inline.h>
#include <set>
#include <stack>
#include <vector> // for typedefs
#include <string>
#include <limits>

#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 { // geos.geom

struct CoordinateLessThen;

// Define the following to make assignments and copy constructions
// NON-inline (will let profilers report usages)
//#define PROFILE_COORDINATE_COPIES 1
class GEOS_DLL Coordinate {

private:

    static Coordinate _nullCoord;

public:
    typedef std::set<const Coordinate*, CoordinateLessThen> ConstSet;

    typedef std::vector<const Coordinate*> ConstVect;

    typedef std::stack<const Coordinate*> ConstStack;

    typedef std::vector<Coordinate> Vect;

    double x;

    double y;

    double z;

    void setNull();

    static Coordinate& getNull();

    bool isNull() const;

    Coordinate(double xNew = 0.0, double yNew = 0.0, double zNew = DoubleNotANumber);

    bool equals2D(const Coordinate& other) const;

    bool equals(const Coordinate& other) const;

    int compareTo(const Coordinate& other) const;

    bool equals3D(const Coordinate& other) const;

    std::string toString() const;

    //void makePrecise(const PrecisionModel *pm);

    double distance(const Coordinate& p) const;

    double distanceSquared(const Coordinate& p) const;

    struct GEOS_DLL HashCode {
        size_t operator()(const Coordinate & c) const;
    };

};

struct GEOS_DLL CoordinateLessThen {

    bool operator()(const Coordinate* a, const Coordinate* b) const;
    bool operator()(const Coordinate& a, const Coordinate& b) const;

};

inline bool
operator<(const Coordinate& a, const Coordinate& b)
{
    return CoordinateLessThen()(a, b);
}

GEOS_DLL std::ostream& operator<< (std::ostream& os, const Coordinate& c);

GEOS_DLL bool operator==(const Coordinate& a, const Coordinate& b);

GEOS_DLL bool operator!=(const Coordinate& a, const Coordinate& b);



} // namespace geos.geom
} // namespace geos

#ifdef _MSC_VER
#pragma warning(pop)
#endif

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

#endif // ndef GEOS_GEOM_COORDINATE_H