libs/geometry/doc/doxy/doxygen_output/xml/group__access.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__access" kind="group">
   4     <compoundname>access</compoundname>
   5     <title>access: get/set coordinate values, make objects, clear geometries, append point(s)</title>
   6     <innerclass refid="structboost_1_1geometry_1_1radius__type" prot="public">boost::geometry::radius_type</innerclass>
   7       <sectiondef kind="func">
   8       <memberdef kind="function" id="group__access_1ga1e0627c198b569ca7f278acce06120ee" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   9         <templateparamlist>
  10           <param>
  11             <type>std::size_t</type>
  12             <declname>I</declname>
  13             <defname>I</defname>
  14           </param>
  15           <param>
  16             <type>typename Geometry</type>
  17           </param>
  18         </templateparamlist>
  19         <type>radius_type&lt; Geometry &gt;::type</type>
  20         <definition>radius_type&lt;Geometry&gt;::type boost::geometry::get_radius</definition>
  21         <argsstring>(Geometry const &amp;geometry)</argsstring>
  22         <name>get_radius</name>
  23         <param>
  24           <type>Geometry const &amp;</type>
  25           <declname>geometry</declname>
  26         </param>
  27         <briefdescription>
  28 <para>Function to get radius of a circle / sphere / ellipse / etc. </para>        </briefdescription>
  29         <detaileddescription>
  30 <para><simplesect kind="return"><para>radius The radius for a given axis</para></simplesect>
  31 <parameterlist kind="param"><parameteritem>
  32 <parameternamelist>
  33 <parametername>geometry</parametername>
  34 </parameternamelist>
  35 <parameterdescription>
  36 <para>the geometry to get the radius from </para></parameterdescription>
  37 </parameteritem>
  38 </parameterlist>
  39 <parameterlist kind="templateparam"><parameteritem>
  40 <parameternamelist>
  41 <parametername>I</parametername>
  42 </parameternamelist>
  43 <parameterdescription>
  44 <para>index of the axis </para></parameterdescription>
  45 </parameteritem>
  46 </parameterlist>
  47 </para>        </detaileddescription>
  48         <inbodydescription>
  49         </inbodydescription>
  50         <location file="/home/ubuntu/boost/boost/geometry/core/radius.hpp" line="126" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/radius.hpp" bodystart="126" bodyend="135"/>
  51       </memberdef>
  52       <memberdef kind="function" id="group__access_1ga6c403657f606b2a4d3f64d6e4ae74437" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  53         <templateparamlist>
  54           <param>
  55             <type>std::size_t</type>
  56             <declname>I</declname>
  57             <defname>I</defname>
  58           </param>
  59           <param>
  60             <type>typename Geometry</type>
  61           </param>
  62         </templateparamlist>
  63         <type>void</type>
  64         <definition>void boost::geometry::set_radius</definition>
  65         <argsstring>(Geometry &amp;geometry, typename radius_type&lt; Geometry &gt;::type const &amp;radius)</argsstring>
  66         <name>set_radius</name>
  67         <param>
  68           <type>Geometry &amp;</type>
  69           <declname>geometry</declname>
  70         </param>
  71         <param>
  72           <type>typename radius_type&lt; Geometry &gt;::type const &amp;</type>
  73           <declname>radius</declname>
  74         </param>
  75         <briefdescription>
  76 <para>Function to set the radius of a circle / sphere / ellipse / etc. </para>        </briefdescription>
  77         <detaileddescription>
  78 <para><parameterlist kind="templateparam"><parameteritem>
  79 <parameternamelist>
  80 <parametername>I</parametername>
  81 </parameternamelist>
  82 <parameterdescription>
  83 <para>index of the axis </para></parameterdescription>
  84 </parameteritem>
  85 </parameterlist>
  86 <parameterlist kind="param"><parameteritem>
  87 <parameternamelist>
  88 <parametername>geometry</parametername>
  89 </parameternamelist>
  90 <parameterdescription>
  91 <para>the geometry to change </para></parameterdescription>
  92 </parameteritem>
  93 <parameteritem>
  94 <parameternamelist>
  95 <parametername>radius</parametername>
  96 </parameternamelist>
  97 <parameterdescription>
  98 <para>the radius to set </para></parameterdescription>
  99 </parameteritem>
 100 </parameterlist>
 101 </para>        </detaileddescription>
 102         <inbodydescription>
 103         </inbodydescription>
 104         <location file="/home/ubuntu/boost/boost/geometry/core/radius.hpp" line="145" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/radius.hpp" bodystart="145" bodyend="155"/>
 105       </memberdef>
 106       </sectiondef>
 107     <briefdescription>
 108     </briefdescription>
 109     <detaileddescription>
 110     </detaileddescription>
 111   </compounddef>
 112 </doxygen>