<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GEOS: geos::io::WKBWriter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacegeos.html">geos</a> </li>
<li><a class="el" href="namespacegeos_1_1io.html">io</a> </li>
<li><a class="el" href="classgeos_1_1io_1_1WKBWriter.html">geos::io::WKBWriter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::io::WKBWriter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::io::WKBWriter" -->
<p>Writes a Geometry into Well-Known Binary format.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="io_8h_source.html">geos.h</a>></code></p>
<p><a href="classgeos_1_1io_1_1WKBWriter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa28d8236bab146aa0a27b6107035e65a"></a><!-- doxytag: member="geos::io::WKBWriter::WKBWriter" ref="aa28d8236bab146aa0a27b6107035e65a" args="(int dims=2, int bo=getMachineByteOrder(), bool includeSRID=false)" -->
</td><td class="memItemRight" valign="bottom"><b>WKBWriter</b> (int dims=2, int bo=getMachineByteOrder(), bool includeSRID=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b0fb452c9e0de8dddf99c0572442758"></a><!-- doxytag: member="geos::io::WKBWriter::getOutputDimension" ref="a8b0fb452c9e0de8dddf99c0572442758" args="() const " -->
virtual int </td><td class="memItemRight" valign="bottom"><b>getOutputDimension</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbbf5a9ed537c0bbcd27a586133ba57e"></a><!-- doxytag: member="geos::io::WKBWriter::setOutputDimension" ref="abbbf5a9ed537c0bbcd27a586133ba57e" args="(int newOutputDimension)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setOutputDimension</b> (int newOutputDimension)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae3d4066672f1bd4208e3ff30a5d81e4"></a><!-- doxytag: member="geos::io::WKBWriter::getByteOrder" ref="aae3d4066672f1bd4208e3ff30a5d81e4" args="() const " -->
virtual int </td><td class="memItemRight" valign="bottom"><b>getByteOrder</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fea56d43fdde71eed22d8e32320d149"></a><!-- doxytag: member="geos::io::WKBWriter::setByteOrder" ref="a7fea56d43fdde71eed22d8e32320d149" args="(int newByteOrder)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setByteOrder</b> (int newByteOrder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc3c82f648a5bb04b995c165dee2a6ff"></a><!-- doxytag: member="geos::io::WKBWriter::getIncludeSRID" ref="acc3c82f648a5bb04b995c165dee2a6ff" args="() const " -->
virtual int </td><td class="memItemRight" valign="bottom"><b>getIncludeSRID</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacec974a24fc0824020bc7164196d7ca"></a><!-- doxytag: member="geos::io::WKBWriter::setIncludeSRID" ref="aacec974a24fc0824020bc7164196d7ca" args="(int newIncludeSRID)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setIncludeSRID</b> (int newIncludeSRID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1io_1_1WKBWriter.html#ae53d5c9b74bb0b21e96cc56e567c0b3b">write</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &g, std::ostream &os)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a Geometry to an ostream. <a href="#ae53d5c9b74bb0b21e96cc56e567c0b3b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1io_1_1WKBWriter.html#acdf88f51d2ae1f87a836cb84a8a6cb6c">writeHEX</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> &g, std::ostream &os)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a Geometry to an ostream in binary hex format. <a href="#acdf88f51d2ae1f87a836cb84a8a6cb6c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Writes a Geometry into Well-Known Binary format. </p>
<p>The WKB format is specified in the OGC Simple Features for SQL specification. This implementation supports the extended WKB standard for representing 3-dimensional coordinates. The presence of 3D coordinates is signified by setting the high bit of the wkbType word.</p>
<p>Empty Points cannot be represented in WKB; an IllegalArgumentException will be thrown if one is written. The WKB specification does not support representing LinearRing they will be written as LineString</p>
<p>This class is designed to support reuse of a single instance to read multiple geometries. This class is not thread-safe; each thread should create its own instance.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgeos_1_1io_1_1WKBReader.html" title="Reads a Geometry from Well-Known Binary format.">WKBReader</a> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae53d5c9b74bb0b21e96cc56e567c0b3b"></a><!-- doxytag: member="geos::io::WKBWriter::write" ref="ae53d5c9b74bb0b21e96cc56e567c0b3b" args="(const geom::Geometry &g, std::ostream &os)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::io::WKBWriter::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> & </td>
<td class="paramname"> <em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a Geometry to an ostream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>g</em> </td><td>the geometry to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>os</em> </td><td>the output stream </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>IOException</em> </td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acdf88f51d2ae1f87a836cb84a8a6cb6c"></a><!-- doxytag: member="geos::io::WKBWriter::writeHEX" ref="acdf88f51d2ae1f87a836cb84a8a6cb6c" args="(const geom::Geometry &g, std::ostream &os)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::io::WKBWriter::writeHEX </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> & </td>
<td class="paramname"> <em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a Geometry to an ostream in binary hex format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>g</em> </td><td>the geometry to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>os</em> </td><td>the output stream </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>IOException</em> </td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="WKBWriter_8h_source.html">WKBWriter.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
