WKBWriter.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2005-2006 Refractions Research Inc.
 * Copyright (C) 2001-2002 Vivid Solutions 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: io/WKBWriter.java rev. 1.1 (JTS-1.7)
 *
 **********************************************************************/
 
#ifndef GEOS_IO_WKBWRITER_H
#define GEOS_IO_WKBWRITER_H
 
#include <geos/export.h>
 
#include <geos/util/Machine.h> // for getMachineByteOrder
#include <iosfwd>
 
// Forward declarations
namespace geos {
        namespace geom {
 
                class CoordinateSequence;
                class Geometry;
                class GeometryCollection;
                class Point;
                class LineString;
                class LinearRing;
                class Polygon;
                class MultiPoint;
                class MultiLineString;
                class MultiPolygon;
                class PrecisionModel;
 
        } // namespace geom
} // namespace geos
 
namespace geos {
namespace io {

class GEOS_DLL WKBWriter {
 
public:
        /*
         * \brief
         * Initializes writer with target coordinate dimension, endianness 
     * flag and SRID value.
     *
     * @param dims Supported values are 2 or 3.  Note that 3 indicates
     * up to 3 dimensions will be written but 2D WKB is still produced for 2D geometries.
     * @param bo output byte order - default to native machine byte order. 
     * Legal values include 0 (big endian/xdr) and 1 (little endian/ndr).
     * @param incudeSRID true if SRID should be included in WKB (an 
     * extension).
     */
        WKBWriter(int dims=2, int bo=getMachineByteOrder(), bool includeSRID=false);
 
        /*
         * \brief
         * Destructor.
         */
        virtual ~WKBWriter();
 
        /*
         * \brief
         * Returns the output dimension used by the
         * <code>WKBWriter</code>.
         */
        virtual int getOutputDimension() const { return defaultOutputDimension; }
 
        /*
         * Sets the output dimension used by the <code>WKBWriter</code>.  
         *
         * @param newOutputDimension Supported values are 2 or 3. 
         * Note that 3 indicates up to 3 dimensions will be written but
         * 2D WKB is still produced for 2D geometries.
         */
        virtual void setOutputDimension(int newOutputDimension);
        
        /*
         * \brief
         * Returns the byte order used by the
         * <code>WKBWriter</code>.
         */
        virtual int getByteOrder() const { return byteOrder; }
 
        /*
         * Sets the byte order used by the
         * <code>WKBWriter</code>.
         */
        virtual void setByteOrder(int newByteOrder);
 
        /*
         * \brief
         * Returns whether SRID values are output by the
         * <code>WKBWriter</code>.
         */
        virtual int getIncludeSRID() const { return includeSRID; }
 
        /*
         * Sets whether SRID values should be output by the
         * <code>WKBWriter</code>.
         */
        virtual void setIncludeSRID(int newIncludeSRID) { includeSRID = (0 == newIncludeSRID ? false : true); }

        void write(const geom::Geometry &g, std::ostream &os);
                // throws IOException, ParseException

        void writeHEX(const geom::Geometry &g, std::ostream &os);
                // throws IOException, ParseException
 
private:
 
        int defaultOutputDimension;
    int outputDimension;
 
        int byteOrder;
        
        bool includeSRID;
 
        std::ostream *outStream;
 
        unsigned char buf[8];
 
        void writePoint(const geom::Point &p);
                // throws IOException
 
        void writeLineString(const geom::LineString &ls);
                // throws IOException
 
        void writePolygon(const geom::Polygon &p);
                // throws IOException
 
        void writeGeometryCollection(const geom::GeometryCollection &c, int wkbtype);
                // throws IOException, ParseException
 
        void writeCoordinateSequence(const geom::CoordinateSequence &cs, bool sized);
                // throws IOException
 
        void writeCoordinate(const geom::CoordinateSequence &cs, int idx, bool is3d);
                // throws IOException
 
        void writeGeometryType(int geometryType, int SRID);
                // throws IOException
 
        void writeSRID(int SRID);
                // throws IOException
 
        void writeByteOrder();
                // throws IOException
 
        void writeInt(int intValue);
                // throws IOException
 
};
 
} // namespace io
} // namespace geos
 
#endif // #ifndef GEOS_IO_WKBWRITER_H