libs/geometry/doc/html/geometry/reference/adapted/register/boost_geometry_register_point_2d_const.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>BOOST_GEOMETRY_REGISTER_POINT_2D_CONST</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="../register.html" title="Macro's for adaption">
   9 <link rel="prev" href="boost_geometry_register_point_2d.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D">
  10 <link rel="next" href="boost_geometry_register_point_2d_get_set.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET">
  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="boost_geometry_register_point_2d.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../register.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="boost_geometry_register_point_2d_get_set.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.adapted.register.boost_geometry_register_point_2d_const"></a><a class="link" href="boost_geometry_register_point_2d_const.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_CONST">BOOST_GEOMETRY_REGISTER_POINT_2D_CONST</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idp87185744"></a>
  31 Macro to register a 2D point type (const version)
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.description"></a></span><a class="link" href="boost_geometry_register_point_2d_const.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_const.description">Description</a>
  36           </h6>
  37 <p>
  38             The macro BOOST_GEOMETRY_REGISTER_POINT_2D_CONST registers a two-dimensional
  39             point type such that it is recognized by Boost.Geometry and that Boost.Geometry
  40             functionality can used with the specified type.. The const version registers
  41             only read access to the fields, the point type is therefore read-only
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.h1"></a>
  45             <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.synopsis"></a></span><a class="link" href="boost_geometry_register_point_2d_const.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_const.synopsis">Synopsis</a>
  46           </h6>
  47 <p>
  48 </p>
  49 <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_GEOMETRY_REGISTER_POINT_2D_CONST</span><span class="special">(</span><span class="identifier">Point</span><span class="special">,</span> <span class="identifier">CoordinateType</span><span class="special">,</span> <span class="identifier">CoordinateSystem</span><span class="special">,</span>
  50                                         <span class="identifier">Field0</span><span class="special">,</span> <span class="identifier">Field1</span><span class="special">)</span></pre>
  51 <p>
  52           </p>
  53 <h6>
  54 <a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.parameters"></a></span><a class="link" href="boost_geometry_register_point_2d_const.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_const.parameters">Parameters</a>
  56           </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 </colgroup>
  62 <thead><tr>
  63 <th>
  64                     <p>
  65                       Name
  66                     </p>
  67                   </th>
  68 <th>
  69                     <p>
  70                       Description
  71                     </p>
  72                   </th>
  73 </tr></thead>
  74 <tbody>
  75 <tr>
  76 <td>
  77                     <p>
  78                       Point
  79                     </p>
  80                   </td>
  81 <td>
  82                     <p>
  83                       Point type to be registered
  84                     </p>
  85                   </td>
  86 </tr>
  87 <tr>
  88 <td>
  89                     <p>
  90                       CoordinateType
  91                     </p>
  92                   </td>
  93 <td>
  94                     <p>
  95                       Type of the coordinates of the point (e.g. double)
  96                     </p>
  97                   </td>
  98 </tr>
  99 <tr>
 100 <td>
 101                     <p>
 102                       CoordinateSystem
 103                     </p>
 104                   </td>
 105 <td>
 106                     <p>
 107                       Coordinate system (e.g. cs::cartesian)
 108                     </p>
 109                   </td>
 110 </tr>
 111 <tr>
 112 <td>
 113                     <p>
 114                       Field0
 115                     </p>
 116                   </td>
 117 <td>
 118                     <p>
 119                       Member containing first (usually x) coordinate
 120                     </p>
 121                   </td>
 122 </tr>
 123 <tr>
 124 <td>
 125                     <p>
 126                       Field1
 127                     </p>
 128                   </td>
 129 <td>
 130                     <p>
 131                       Member containing second (usually y) coordinate
 132                     </p>
 133                   </td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 <h6>
 138 <a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.h3"></a>
 139             <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_const.header"></a></span><a class="link" href="boost_geometry_register_point_2d_const.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_const.header">Header</a>
 140           </h6>
 141 <p>
 142             <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">geometries</span><span class="special">/</span><span class="keyword">register</span><span class="special">/</span><span class="identifier">point</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 143           </p>
 144 </div>
 145 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 146 <td align="left"></td>
 147 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 148       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 149       affiliates<p>
 150         Distributed under the Boost Software License, Version 1.0. (See accompanying
 151         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>)
 152       </p>
 153 </div></td>
 154 </tr></table>
 155 <hr>
 156 <div class="spirit-nav">
 157 <a accesskey="p" href="boost_geometry_register_point_2d.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../register.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="boost_geometry_register_point_2d_get_set.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 158 </div>
 159 </body>
 160 </html>