libs/geometry/doc/doxy/doxygen_output/xml/structboost_1_1geometry_1_1ever__circling__iterator.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="structboost_1_1geometry_1_1ever__circling__iterator" kind="struct" prot="public">
   4     <compoundname>boost::geometry::ever_circling_iterator</compoundname>
   5     <basecompoundref prot="public" virt="non-virtual">detail::iterators::iterator_base&lt; ever_circling_iterator&lt; Iterator &gt;, Iterator &gt;</basecompoundref>
   6     <includes local="no">ever_circling_iterator.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename Iterator</type>
  10       </param>
  11     </templateparamlist>
  12       <sectiondef kind="friend">
  13       <memberdef kind="friend" id="structboost_1_1geometry_1_1ever__circling__iterator_1ac09f73e325921cc50ebcd96bed0f8096" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  14         <type>friend class</type>
  15         <definition>friend class boost::iterator_core_access</definition>
  16         <argsstring></argsstring>
  17         <name>boost::iterator_core_access</name>
  18         <briefdescription>
  19         </briefdescription>
  20         <detaileddescription>
  21         </detaileddescription>
  22         <inbodydescription>
  23         </inbodydescription>
  24         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="45" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="45" bodyend="-1"/>
  25       </memberdef>
  26       </sectiondef>
  27       <sectiondef kind="private-attrib">
  28       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__iterator_1aa2c0fd2e3b0d9078d27fe336e0f33939" prot="private" static="no" mutable="no">
  29         <type>Iterator</type>
  30         <definition>Iterator boost::geometry::ever_circling_iterator&lt; Iterator &gt;::m_begin</definition>
  31         <argsstring></argsstring>
  32         <name>m_begin</name>
  33         <briefdescription>
  34         </briefdescription>
  35         <detaileddescription>
  36         </detaileddescription>
  37         <inbodydescription>
  38         </inbodydescription>
  39         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="93" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="93" bodyend="-1"/>
  40       </memberdef>
  41       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__iterator_1a05b4ddd0df4d652792d6a9c6a2b92360" prot="private" static="no" mutable="no">
  42         <type>Iterator</type>
  43         <definition>Iterator boost::geometry::ever_circling_iterator&lt; Iterator &gt;::m_end</definition>
  44         <argsstring></argsstring>
  45         <name>m_end</name>
  46         <briefdescription>
  47         </briefdescription>
  48         <detaileddescription>
  49         </detaileddescription>
  50         <inbodydescription>
  51         </inbodydescription>
  52         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="94" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="94" bodyend="-1"/>
  53       </memberdef>
  54       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__iterator_1a03427455decf2542cebd73a93b1f4a22" prot="private" static="no" mutable="no">
  55         <type>bool</type>
  56         <definition>bool boost::geometry::ever_circling_iterator&lt; Iterator &gt;::m_skip_first</definition>
  57         <argsstring></argsstring>
  58         <name>m_skip_first</name>
  59         <briefdescription>
  60         </briefdescription>
  61         <detaileddescription>
  62         </detaileddescription>
  63         <inbodydescription>
  64         </inbodydescription>
  65         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="95" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="95" bodyend="-1"/>
  66       </memberdef>
  67       </sectiondef>
  68       <sectiondef kind="public-func">
  69       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__iterator_1ab1bea096782b6bf1071633f7eee446b3" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
  70         <type></type>
  71         <definition>boost::geometry::ever_circling_iterator&lt; Iterator &gt;::ever_circling_iterator</definition>
  72         <argsstring>(Iterator begin, Iterator end, bool skip_first=false)</argsstring>
  73         <name>ever_circling_iterator</name>
  74         <param>
  75           <type>Iterator</type>
  76           <declname>begin</declname>
  77         </param>
  78         <param>
  79           <type>Iterator</type>
  80           <declname>end</declname>
  81         </param>
  82         <param>
  83           <type>bool</type>
  84           <declname>skip_first</declname>
  85           <defval>false</defval>
  86         </param>
  87         <briefdescription>
  88         </briefdescription>
  89         <detaileddescription>
  90         </detaileddescription>
  91         <inbodydescription>
  92         </inbodydescription>
  93         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="47" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="47" bodyend="54"/>
  94       </memberdef>
  95       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__iterator_1a604db6961d67b9ca42e7f6991ae314e2" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
  96         <type></type>
  97         <definition>boost::geometry::ever_circling_iterator&lt; Iterator &gt;::ever_circling_iterator</definition>
  98         <argsstring>(Iterator begin, Iterator end, Iterator start, bool skip_first=false)</argsstring>
  99         <name>ever_circling_iterator</name>
 100         <param>
 101           <type>Iterator</type>
 102           <declname>begin</declname>
 103         </param>
 104         <param>
 105           <type>Iterator</type>
 106           <declname>end</declname>
 107         </param>
 108         <param>
 109           <type>Iterator</type>
 110           <declname>start</declname>
 111         </param>
 112         <param>
 113           <type>bool</type>
 114           <declname>skip_first</declname>
 115           <defval>false</defval>
 116         </param>
 117         <briefdescription>
 118         </briefdescription>
 119         <detaileddescription>
 120         </detaileddescription>
 121         <inbodydescription>
 122         </inbodydescription>
 123         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="56" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="56" bodyend="63"/>
 124       </memberdef>
 125       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__iterator_1ad7f111e33ea9a06c51e6a4971e920c25" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 126         <type>void</type>
 127         <definition>void boost::geometry::ever_circling_iterator&lt; Iterator &gt;::moveto</definition>
 128         <argsstring>(Iterator it)</argsstring>
 129         <name>moveto</name>
 130         <param>
 131           <type>Iterator</type>
 132           <declname>it</declname>
 133         </param>
 134         <briefdescription>
 135         </briefdescription>
 136         <detaileddescription>
 137 <para>Navigate to a certain position, should be in [start .. end], if at end it will circle again. </para>        </detaileddescription>
 138         <inbodydescription>
 139         </inbodydescription>
 140         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="67" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="67" bodyend="71"/>
 141       </memberdef>
 142       </sectiondef>
 143       <sectiondef kind="private-func">
 144       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__iterator_1ad2194d41a1c5a9d3a5901e394067175e" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 145         <type>void</type>
 146         <definition>void boost::geometry::ever_circling_iterator&lt; Iterator &gt;::check_end</definition>
 147         <argsstring>(bool possibly_skip=true)</argsstring>
 148         <name>check_end</name>
 149         <param>
 150           <type>bool</type>
 151           <declname>possibly_skip</declname>
 152           <defval>true</defval>
 153         </param>
 154         <briefdescription>
 155         </briefdescription>
 156         <detaileddescription>
 157         </detaileddescription>
 158         <inbodydescription>
 159         </inbodydescription>
 160         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="81" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="81" bodyend="91"/>
 161       </memberdef>
 162       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__iterator_1a03d1de62de05ac25c5c9d1cfc369eb2e" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 163         <type>void</type>
 164         <definition>void boost::geometry::ever_circling_iterator&lt; Iterator &gt;::increment</definition>
 165         <argsstring>(bool possibly_skip=true)</argsstring>
 166         <name>increment</name>
 167         <param>
 168           <type>bool</type>
 169           <declname>possibly_skip</declname>
 170           <defval>true</defval>
 171         </param>
 172         <briefdescription>
 173         </briefdescription>
 174         <detaileddescription>
 175         </detaileddescription>
 176         <inbodydescription>
 177         </inbodydescription>
 178         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="75" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="75" bodyend="79"/>
 179       </memberdef>
 180       </sectiondef>
 181     <briefdescription>
 182 <para>Iterator which ever circles through a range. </para>    </briefdescription>
 183     <detaileddescription>
 184 <para><parameterlist kind="templateparam"><parameteritem>
 185 <parameternamelist>
 186 <parametername>Iterator</parametername>
 187 </parameternamelist>
 188 <parameterdescription>
 189 <para>iterator on which this class is based on</para></parameterdescription>
 190 </parameteritem>
 191 </parameterlist>
 192 If the iterator arrives at range.end() it restarts from the beginning. So it has to be stopped in another way. Don&apos;t call for(....; it++) because it will turn in an endless loop <simplesect kind="note"><para>Name inspired on David Bowie&apos;s &quot;Chant Of The Ever Circling Skeletal Family&quot; </para></simplesect>
 193 </para>    </detaileddescription>
 194     <inheritancegraph>
 195       <node id="352">
 196         <label>detail::iterators::iterator_base&lt; ever_circling_iterator&lt; Iterator &gt;, Iterator &gt;</label>
 197       </node>
 198       <node id="351">
 199         <label>boost::geometry::ever_circling_iterator&lt; Iterator &gt;</label>
 200         <link refid="structboost_1_1geometry_1_1ever__circling__iterator"/>
 201         <childnode refid="352" relation="public-inheritance">
 202         </childnode>
 203       </node>
 204     </inheritancegraph>
 205     <collaborationgraph>
 206       <node id="354">
 207         <label>detail::iterators::iterator_base&lt; ever_circling_iterator&lt; Iterator &gt;, Iterator &gt;</label>
 208       </node>
 209       <node id="353">
 210         <label>boost::geometry::ever_circling_iterator&lt; Iterator &gt;</label>
 211         <link refid="structboost_1_1geometry_1_1ever__circling__iterator"/>
 212         <childnode refid="354" relation="public-inheritance">
 213         </childnode>
 214       </node>
 215     </collaborationgraph>
 216     <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="44" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="38" bodyend="96"/>
 217     <listofallmembers>
 218       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1ac09f73e325921cc50ebcd96bed0f8096" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>boost::iterator_core_access</name></member>
 219       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1ad2194d41a1c5a9d3a5901e394067175e" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>check_end</name></member>
 220       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1ab1bea096782b6bf1071633f7eee446b3" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>ever_circling_iterator</name></member>
 221       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1a604db6961d67b9ca42e7f6991ae314e2" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>ever_circling_iterator</name></member>
 222       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1a03d1de62de05ac25c5c9d1cfc369eb2e" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>increment</name></member>
 223       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1aa2c0fd2e3b0d9078d27fe336e0f33939" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>m_begin</name></member>
 224       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1a05b4ddd0df4d652792d6a9c6a2b92360" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>m_end</name></member>
 225       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1a03427455decf2542cebd73a93b1f4a22" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>m_skip_first</name></member>
 226       <member refid="structboost_1_1geometry_1_1ever__circling__iterator_1ad7f111e33ea9a06c51e6a4971e920c25" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_iterator</scope><name>moveto</name></member>
 227     </listofallmembers>
 228   </compounddef>
 229 </doxygen>