libs/geometry/doc/html/geometry/reference/io/wkt/wkt.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>wkt</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../wkt.html" title="WKT (Well-Known Text)">
   9 <link rel="prev" href="read_wkt.html" title="read_wkt">
  10 <link rel="next" href="../svg.html" title="SVG (Scalable Vector Graphics)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="read_wkt.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wkt.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../svg.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="geometry.reference.io.wkt.wkt"></a><a class="link" href="wkt.html" title="wkt">wkt</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46186984634976"></a>
  31 Main WKT-streaming function.
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.io.wkt.wkt.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.synopsis"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.synopsis">Synopsis</a>
  36           </h6>
  37 <p>
  38 </p>
  39 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
  40 <span class="identifier">wkt_manipulator</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</span> <span class="identifier">wkt</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
  41 <p>
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.io.wkt.wkt.h1"></a>
  45             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.parameters"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.parameters">Parameters</a>
  46           </h6>
  47 <div class="informaltable"><table class="table">
  48 <colgroup>
  49 <col>
  50 <col>
  51 <col>
  52 <col>
  53 </colgroup>
  54 <thead><tr>
  55 <th>
  56                     <p>
  57                       Type
  58                     </p>
  59                   </th>
  60 <th>
  61                     <p>
  62                       Concept
  63                     </p>
  64                   </th>
  65 <th>
  66                     <p>
  67                       Name
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Description
  73                     </p>
  74                   </th>
  75 </tr></thead>
  76 <tbody><tr>
  77 <td>
  78                     <p>
  79                       Geometry const &amp;
  80                     </p>
  81                   </td>
  82 <td>
  83                     <p>
  84                       Any type fulfilling a Geometry Concept
  85                     </p>
  86                   </td>
  87 <td>
  88                     <p>
  89                       geometry
  90                     </p>
  91                   </td>
  92 <td>
  93                     <p>
  94                       A model of the specified concept
  95                     </p>
  96                   </td>
  97 </tr></tbody>
  98 </table></div>
  99 <h6>
 100 <a name="geometry.reference.io.wkt.wkt.h2"></a>
 101             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.header"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.header">Header</a>
 102           </h6>
 103 <p>
 104             Either
 105           </p>
 106 <p>
 107             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 108           </p>
 109 <p>
 110             Or
 111           </p>
 112 <p>
 113             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">io</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">/</span><span class="identifier">write</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 114           </p>
 115 <h6>
 116 <a name="geometry.reference.io.wkt.wkt.h3"></a>
 117             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.conformance"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.conformance">Conformance</a>
 118           </h6>
 119 <p>
 120             The function wkt implements function AsText from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
 121             Simple Feature Specification</a>.
 122           </p>
 123 <div class="note"><table border="0" summary="Note">
 124 <tr>
 125 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
 126 <th align="left">Note</th>
 127 </tr>
 128 <tr><td align="left" valign="top"><p>
 129               wkt is not named "AsText" or "as_text" because
 130               Boost.Geometry also supports other textformats (svg, dsv)
 131             </p></td></tr>
 132 </table></div>
 133 <h6>
 134 <a name="geometry.reference.io.wkt.wkt.h4"></a>
 135             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.example"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.example">Example</a>
 136           </h6>
 137 <p>
 138             Shows the usage of wkt
 139           </p>
 140 <p>
 141 </p>
 142 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 143
 144 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 145 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 146 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 147
 148 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 149 <span class="special">{</span>
 150     <span class="keyword">namespace</span> <span class="identifier">geom</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span>
 151     <span class="keyword">typedef</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point_type</span><span class="special">;</span>
 152
 153     <span class="identifier">point_type</span> <span class="identifier">point</span> <span class="special">=</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">3</span><span class="special">,</span> <span class="number">6</span><span class="special">);</span>
 154     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;</span> <span class="identifier">polygon</span><span class="special">;</span>
 155     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">geom</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
 156     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">geom</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">0</span><span class="special">,</span> <span class="number">4</span><span class="special">));</span>
 157     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">geom</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">4</span><span class="special">,</span> <span class="number">4</span><span class="special">));</span>
 158     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">geom</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">4</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
 159     <span class="identifier">geom</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">geom</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">geom</span><span class="special">::</span><span class="identifier">make</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
 160
 161     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">(</span><span class="identifier">point</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 162     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 163
 164     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 165 <span class="special">}</span>
 166 </pre>
 167 <p>
 168           </p>
 169 <p>
 170             Output:
 171           </p>
 172 <pre class="programlisting">POINT(3 6)
 173 POLYGON((0 0,0 4,4 4,4 0,0 0))
 174 </pre>
 175 <h6>
 176 <a name="geometry.reference.io.wkt.wkt.h5"></a>
 177             <span class="phrase"><a name="geometry.reference.io.wkt.wkt.see_also"></a></span><a class="link" href="wkt.html#geometry.reference.io.wkt.wkt.see_also">See
 178             also</a>
 179           </h6>
 180 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 181                 <a class="link" href="read_wkt.html" title="read_wkt">Read WKT</a>
 182               </li></ul></div>
 183 </div>
 184 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 185 <td align="left"></td>
 186 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 187       Wulkiewicz, Oracle and/or its affiliates<p>
 188         Distributed under the Boost Software License, Version 1.0. (See accompanying
 189         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 190       </p>
 191 </div></td>
 192 </tr></table>
 193 <hr>
 194 <div class="spirit-nav">
 195 <a accesskey="p" href="read_wkt.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wkt.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../svg.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 196 </div>
 197 </body>
 198 </html>