libs/geometry/doc/doxy/doxygen_output/xml/group__get.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="group__get" kind="group">
   4     <compoundname>get</compoundname>
   5     <title>get: get geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__get_1ga6f2549aa15489bdfa2e0ee28c620ab07" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>std::size_t</type>
  11             <declname>Dimension</declname>
  12             <defname>Dimension</defname>
  13           </param>
  14           <param>
  15             <type>typename Geometry</type>
  16           </param>
  17         </templateparamlist>
  18         <type>coordinate_type&lt; Geometry &gt;::type</type>
  19         <definition>coordinate_type&lt;Geometry&gt;::type boost::geometry::get</definition>
  20         <argsstring>(Geometry const &amp;geometry)</argsstring>
  21         <name>get</name>
  22         <param>
  23           <type>Geometry const &amp;</type>
  24           <declname>geometry</declname>
  25         </param>
  26         <briefdescription>
  27 <para>Get coordinate value of a geometry (usually a point) </para>        </briefdescription>
  28         <detaileddescription>
  29 <para>The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere.</para><para><parameterlist kind="templateparam"><parameteritem>
  30 <parameternamelist>
  31 <parametername>Dimension</parametername>
  32 </parameternamelist>
  33 <parameterdescription>
  34 <para>Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry </para></parameterdescription>
  35 </parameteritem>
  36 <parameteritem>
  37 <parameternamelist>
  38 <parametername>Geometry</parametername>
  39 </parameternamelist>
  40 <parameterdescription>
  41 <para>Any type fulfilling a Geometry Concept (usually a Point Concept) </para></parameterdescription>
  42 </parameteritem>
  43 </parameterlist>
  44 <parameterlist kind="param"><parameteritem>
  45 <parameternamelist>
  46 <parametername>geometry</parametername>
  47 </parameternamelist>
  48 <parameterdescription>
  49 <para>A model of the specified concept (usually a point) </para></parameterdescription>
  50 </parameteritem>
  51 </parameterlist>
  52 <simplesect kind="return"><para>The coordinate value of specified dimension of specified geometry</para></simplesect>
  53  <qbk>[include reference/core/get_point.qbk]</qbk>  </para>        </detaileddescription>
  54         <inbodydescription>
  55         </inbodydescription>
  56         <location file="/home/ubuntu/boost/boost/geometry/core/access.hpp" line="269" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/access.hpp" bodystart="269" bodyend="287"/>
  57       </memberdef>
  58       <memberdef kind="function" id="group__get_1gabf9ceb2655358244b0348cef1f308288" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  59         <templateparamlist>
  60           <param>
  61             <type>std::size_t</type>
  62             <declname>Index</declname>
  63             <defname>Index</defname>
  64           </param>
  65           <param>
  66             <type>std::size_t</type>
  67             <declname>Dimension</declname>
  68             <defname>Dimension</defname>
  69           </param>
  70           <param>
  71             <type>typename Geometry</type>
  72           </param>
  73         </templateparamlist>
  74         <type>coordinate_type&lt; Geometry &gt;::type</type>
  75         <definition>coordinate_type&lt;Geometry&gt;::type boost::geometry::get</definition>
  76         <argsstring>(Geometry const &amp;geometry)</argsstring>
  77         <name>get</name>
  78         <param>
  79           <type>Geometry const &amp;</type>
  80           <declname>geometry</declname>
  81         </param>
  82         <briefdescription>
  83 <para>get coordinate value of a Box or Segment </para>        </briefdescription>
  84         <detaileddescription>
  85 <para>The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere. <parameterlist kind="templateparam"><parameteritem>
  86 <parameternamelist>
  87 <parametername>Index</parametername>
  88 </parameternamelist>
  89 <parameterdescription>
  90 <para>Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point. </para></parameterdescription>
  91 </parameteritem>
  92 <parameteritem>
  93 <parameternamelist>
  94 <parametername>Dimension</parametername>
  95 </parameternamelist>
  96 <parameterdescription>
  97 <para>Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry </para></parameterdescription>
  98 </parameteritem>
  99 <parameteritem>
 100 <parameternamelist>
 101 <parametername>Geometry</parametername>
 102 </parameternamelist>
 103 <parameterdescription>
 104 <para>Any type fulfilling a Box Concept or a Segment Concept </para></parameterdescription>
 105 </parameteritem>
 106 </parameterlist>
 107 <parameterlist kind="param"><parameteritem>
 108 <parameternamelist>
 109 <parametername>geometry</parametername>
 110 </parameternamelist>
 111 <parameterdescription>
 112 <para>A model of the specified concept </para></parameterdescription>
 113 </parameteritem>
 114 </parameterlist>
 115 <simplesect kind="return"><para>coordinate value</para></simplesect>
 116  <qbk.distinguish>with index</qbk.distinguish>   <qbk>[include reference/core/get_box.qbk]</qbk>  </para>        </detaileddescription>
 117         <inbodydescription>
 118         </inbodydescription>
 119         <location file="/home/ubuntu/boost/boost/geometry/core/access.hpp" line="339" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/access.hpp" bodystart="339" bodyend="358"/>
 120       </memberdef>
 121       <memberdef kind="function" id="group__get_1ga599e31cfc2d3b5074bc3ac4cf24b9152" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 122         <templateparamlist>
 123           <param>
 124             <type>std::size_t</type>
 125             <declname>Dimension</declname>
 126             <defname>Dimension</defname>
 127           </param>
 128           <param>
 129             <type>typename Geometry</type>
 130           </param>
 131         </templateparamlist>
 132         <type>fp_coordinate_type&lt; Geometry &gt;::type</type>
 133         <definition>fp_coordinate_type&lt;Geometry&gt;::type boost::geometry::get_as_radian</definition>
 134         <argsstring>(Geometry const &amp;geometry)</argsstring>
 135         <name>get_as_radian</name>
 136         <param>
 137           <type>Geometry const &amp;</type>
 138           <declname>geometry</declname>
 139         </param>
 140         <briefdescription>
 141 <para>get coordinate value of a point, result is in Radian </para>        </briefdescription>
 142         <detaileddescription>
 143 <para>Result is in Radian, even if source coordinate system is in Degrees <simplesect kind="return"><para>coordinate value</para></simplesect>
 144 <parameterlist kind="templateparam"><parameteritem>
 145 <parameternamelist>
 146 <parametername>Dimension</parametername>
 147 </parameternamelist>
 148 <parameterdescription>
 149 <para>dimension </para></parameterdescription>
 150 </parameteritem>
 151 <parameteritem>
 152 <parameternamelist>
 153 <parametername>Geometry</parametername>
 154 </parameternamelist>
 155 <parameterdescription>
 156 <para>geometry </para></parameterdescription>
 157 </parameteritem>
 158 </parameterlist>
 159 <parameterlist kind="param"><parameteritem>
 160 <parameternamelist>
 161 <parametername>geometry</parametername>
 162 </parameternamelist>
 163 <parameterdescription>
 164 <para>geometry to get coordinate value from </para></parameterdescription>
 165 </parameteritem>
 166 </parameterlist>
 167 <simplesect kind="note"><para>Only applicable to coordinate systems templatized by units, e.g. spherical or geographic coordinate systems </para></simplesect>
 168 </para>        </detaileddescription>
 169         <inbodydescription>
 170         </inbodydescription>
 171         <location file="/home/ubuntu/boost/boost/geometry/core/radian_access.hpp" line="127" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/radian_access.hpp" bodystart="127" bodyend="131"/>
 172       </memberdef>
 173       </sectiondef>
 174     <briefdescription>
 175     </briefdescription>
 176     <detaileddescription>
 177     </detaileddescription>
 178   </compounddef>
 179 </doxygen>