libs/geometry/doc/doxy/doxygen_output/xml/group__set.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__set" kind="group">
   4     <compoundname>set</compoundname>
   5     <title>set: set geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__set_1ga547b9e2d42e58aab04949d056b795702" 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>void</type>
  19         <definition>void boost::geometry::set</definition>
  20         <argsstring>(Geometry &amp;geometry, typename coordinate_type&lt; Geometry &gt;::type const &amp;value)</argsstring>
  21         <name>set</name>
  22         <param>
  23           <type>Geometry &amp;</type>
  24           <declname>geometry</declname>
  25         </param>
  26         <param>
  27           <type>typename coordinate_type&lt; Geometry &gt;::type const &amp;</type>
  28           <declname>value</declname>
  29         </param>
  30         <briefdescription>
  31 <para>Set coordinate value of a geometry (usually a point) </para>        </briefdescription>
  32         <detaileddescription>
  33 <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>
  34 <parameternamelist>
  35 <parametername>Dimension</parametername>
  36 </parameternamelist>
  37 <parameterdescription>
  38 <para>Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry </para></parameterdescription>
  39 </parameteritem>
  40 <parameteritem>
  41 <parameternamelist>
  42 <parametername>Geometry</parametername>
  43 </parameternamelist>
  44 <parameterdescription>
  45 <para>Any type fulfilling a Geometry Concept (usually a Point Concept) </para></parameterdescription>
  46 </parameteritem>
  47 </parameterlist>
  48 <parameterlist kind="param"><parameteritem>
  49 <parameternamelist>
  50 <parametername>geometry</parametername>
  51 </parameternamelist>
  52 <parameterdescription>
  53 <para>geometry to assign coordinate to </para></parameterdescription>
  54 </parameteritem>
  55 <parameteritem>
  56 <parameternamelist>
  57 <parametername>geometry</parametername>
  58 </parameternamelist>
  59 <parameterdescription>
  60 <para>A model of the specified concept (usually a point) </para></parameterdescription>
  61 </parameteritem>
  62 <parameteritem>
  63 <parameternamelist>
  64 <parametername>value</parametername>
  65 </parameternamelist>
  66 <parameterdescription>
  67 <para>The coordinate value to set</para></parameterdescription>
  68 </parameteritem>
  69 </parameterlist>
  70  <qbk>[include reference/core/set_point.qbk]</qbk>  </para>        </detaileddescription>
  71         <inbodydescription>
  72         </inbodydescription>
  73         <location file="/home/ubuntu/boost/boost/geometry/core/access.hpp" line="303" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/access.hpp" bodystart="303" bodyend="322"/>
  74       </memberdef>
  75       <memberdef kind="function" id="group__set_1gab344165e39efdf322c11f5b3205cb302" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  76         <templateparamlist>
  77           <param>
  78             <type>std::size_t</type>
  79             <declname>Index</declname>
  80             <defname>Index</defname>
  81           </param>
  82           <param>
  83             <type>std::size_t</type>
  84             <declname>Dimension</declname>
  85             <defname>Dimension</defname>
  86           </param>
  87           <param>
  88             <type>typename Geometry</type>
  89           </param>
  90         </templateparamlist>
  91         <type>void</type>
  92         <definition>void boost::geometry::set</definition>
  93         <argsstring>(Geometry &amp;geometry, typename coordinate_type&lt; Geometry &gt;::type const &amp;value)</argsstring>
  94         <name>set</name>
  95         <param>
  96           <type>Geometry &amp;</type>
  97           <declname>geometry</declname>
  98         </param>
  99         <param>
 100           <type>typename coordinate_type&lt; Geometry &gt;::type const &amp;</type>
 101           <declname>value</declname>
 102         </param>
 103         <briefdescription>
 104 <para>set coordinate value of a Box / Segment </para>        </briefdescription>
 105         <detaileddescription>
 106 <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>
 107 <parameternamelist>
 108 <parametername>Index</parametername>
 109 </parameternamelist>
 110 <parameterdescription>
 111 <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>
 112 </parameteritem>
 113 <parameteritem>
 114 <parameternamelist>
 115 <parametername>Dimension</parametername>
 116 </parameternamelist>
 117 <parameterdescription>
 118 <para>Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry </para></parameterdescription>
 119 </parameteritem>
 120 <parameteritem>
 121 <parameternamelist>
 122 <parametername>Geometry</parametername>
 123 </parameternamelist>
 124 <parameterdescription>
 125 <para>Any type fulfilling a Box Concept or a Segment Concept </para></parameterdescription>
 126 </parameteritem>
 127 </parameterlist>
 128 <parameterlist kind="param"><parameteritem>
 129 <parameternamelist>
 130 <parametername>geometry</parametername>
 131 </parameternamelist>
 132 <parameterdescription>
 133 <para>geometry to assign coordinate to </para></parameterdescription>
 134 </parameteritem>
 135 <parameteritem>
 136 <parameternamelist>
 137 <parametername>geometry</parametername>
 138 </parameternamelist>
 139 <parameterdescription>
 140 <para>A model of the specified concept </para></parameterdescription>
 141 </parameteritem>
 142 <parameteritem>
 143 <parameternamelist>
 144 <parametername>value</parametername>
 145 </parameternamelist>
 146 <parameterdescription>
 147 <para>The coordinate value to set</para></parameterdescription>
 148 </parameteritem>
 149 </parameterlist>
 150  <qbk.distinguish>with index</qbk.distinguish>   <qbk>[include reference/core/set_box.qbk]</qbk>  </para>        </detaileddescription>
 151         <inbodydescription>
 152         </inbodydescription>
 153         <location file="/home/ubuntu/boost/boost/geometry/core/access.hpp" line="375" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/access.hpp" bodystart="375" bodyend="395"/>
 154       </memberdef>
 155       <memberdef kind="function" id="group__set_1ga78f2e71135a76ccad3e37afab58b0f70" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 156         <templateparamlist>
 157           <param>
 158             <type>std::size_t</type>
 159             <declname>Dimension</declname>
 160             <defname>Dimension</defname>
 161           </param>
 162           <param>
 163             <type>typename Geometry</type>
 164           </param>
 165         </templateparamlist>
 166         <type>void</type>
 167         <definition>void boost::geometry::set_from_radian</definition>
 168         <argsstring>(Geometry &amp;geometry, typename fp_coordinate_type&lt; Geometry &gt;::type const &amp;radians)</argsstring>
 169         <name>set_from_radian</name>
 170         <param>
 171           <type>Geometry &amp;</type>
 172           <declname>geometry</declname>
 173         </param>
 174         <param>
 175           <type>typename fp_coordinate_type&lt; Geometry &gt;::type const &amp;</type>
 176           <declname>radians</declname>
 177         </param>
 178         <briefdescription>
 179 <para>set coordinate value (in radian) to a point </para>        </briefdescription>
 180         <detaileddescription>
 181 <para>Coordinate value will be set correctly, if coordinate system of point is in Degree, Radian value will be converted to Degree</para><para><parameterlist kind="templateparam"><parameteritem>
 182 <parameternamelist>
 183 <parametername>Dimension</parametername>
 184 </parameternamelist>
 185 <parameterdescription>
 186 <para>dimension </para></parameterdescription>
 187 </parameteritem>
 188 <parameteritem>
 189 <parameternamelist>
 190 <parametername>Geometry</parametername>
 191 </parameternamelist>
 192 <parameterdescription>
 193 <para>geometry </para></parameterdescription>
 194 </parameteritem>
 195 </parameterlist>
 196 <parameterlist kind="param"><parameteritem>
 197 <parameternamelist>
 198 <parametername>geometry</parametername>
 199 </parameternamelist>
 200 <parameterdescription>
 201 <para>geometry to assign coordinate to </para></parameterdescription>
 202 </parameteritem>
 203 <parameteritem>
 204 <parameternamelist>
 205 <parametername>radians</parametername>
 206 </parameternamelist>
 207 <parameterdescription>
 208 <para>coordinate value to assign </para></parameterdescription>
 209 </parameteritem>
 210 </parameterlist>
 211 <simplesect kind="note"><para>Only applicable to coordinate systems templatized by units, e.g. spherical or geographic coordinate systems </para></simplesect>
 212 </para>        </detaileddescription>
 213         <inbodydescription>
 214         </inbodydescription>
 215         <location file="/home/ubuntu/boost/boost/geometry/core/radian_access.hpp" line="147" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/radian_access.hpp" bodystart="147" bodyend="152"/>
 216       </memberdef>
 217       </sectiondef>
 218     <briefdescription>
 219     </briefdescription>
 220     <detaileddescription>
 221     </detaileddescription>
 222   </compounddef>
 223 </doxygen>