PrecisionModel.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2011 Sandro Santilli <strk@kbt.io>
 * 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.
 *
 **********************************************************************
 *
 * Last port: geom/PrecisionModel.java r378 (JTS-1.12)
 *
 **********************************************************************/
 
#ifndef GEOS_GEOM_PRECISIONMODEL_H
#define GEOS_GEOM_PRECISIONMODEL_H
 
#include <geos/export.h>
#include <geos/inline.h>
 
 
#include <string>
 
// Forward declarations
namespace geos {
namespace io {
class Unload;
}
namespace geom {
class Coordinate;
}
}
 
namespace geos {
namespace geom { // geos::geom
 
class GEOS_DLL PrecisionModel {
    friend class io::Unload;
 
public:
 
    typedef enum {
 
        FIXED,
 
        FLOATING,
 
        FLOATING_SINGLE
 
    } Type;
 
    PrecisionModel(void);
 
    //
    PrecisionModel(Type nModelType);
 
    PrecisionModel(double newScale, double newOffsetX, double newOffsetY);
 
    PrecisionModel(double newScale);
 
    // copy constructor
    PrecisionModel(const PrecisionModel& pm);
 
    ~PrecisionModel(void);
 
 
    //
    static const double maximumPreciseValue;
 
    double makePrecise(double val) const;
 
    void makePrecise(Coordinate& coord) const;
 
    void makePrecise(Coordinate* coord) const;
 
    //
    bool isFloating() const;
 
    //
    int getMaximumSignificantDigits() const;
 
    //
    Type getType() const;
 
    double getScale() const;
 
    //
    double getOffsetX() const;
 
    //
    double getOffsetY() const;
 
    /*
     *  Sets ´internal` to the precise representation of `external`.
     *
     * @param external the original coordinate
     * @param internal the coordinate whose values will be changed to the
     *                 precise representation of <code>external</code>
     * @deprecated use makePrecise instead
     */
    //void toInternal(const Coordinate& external, Coordinate* internal) const;
 
    /*
     *  Returns the precise representation of <code>external</code>.
     *
     *@param  external  the original coordinate
     *@return
     *  the coordinate whose values will be changed to the precise
     *  representation of <code>external</code>
     * @deprecated use makePrecise instead
     */
    //Coordinate* toInternal(const Coordinate& external) const;
 
    /*
     *  Returns the external representation of <code>internal</code>.
     *
     *@param  internal  the original coordinate
     *@return           the coordinate whose values will be changed to the
     *      external representation of <code>internal</code>
     * @deprecated no longer needed, since internal representation is same as external representation
     */
    //Coordinate* toExternal(const Coordinate& internal) const;
 
    /*
     *  Sets <code>external</code> to the external representation of
     *  <code>internal</code>.
     *
     * @param  internal  the original coordinate
     * @param  external
     *  the coordinate whose values will be changed to the
     *  external representation of <code>internal</code>
     * @deprecated no longer needed, since internal representation is same as external representation
     */
    //void toExternal(const Coordinate& internal, Coordinate* external) const;
 
    std::string toString() const;
 
    //
    int compareTo(const PrecisionModel* other) const;
 
private:
 
    void setScale(double newScale);
    // throw IllegalArgumentException
 
    Type modelType;
 
    double scale;
 
};
 
// Equality operator for PrecisionModel, deprecate it ?
//inline bool operator==(const PrecisionModel& a, const PrecisionModel& b);
 
} // namespace geos::geom
} // namespace geos
 
#ifdef GEOS_INLINE
# include "geos/geom/PrecisionModel.inl"
#endif
 
#endif // ndef GEOS_GEOM_PRECISIONMODEL_H