libs/geometry/doc/doxy/doxygen_output/xml/structboost_1_1geometry_1_1closeable__view.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_1closeable__view" kind="struct" prot="public">
   4     <compoundname>boost::geometry::closeable_view</compoundname>
   5     <includes local="no">closeable_view.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>typename Range</type>
   9       </param>
  10       <param>
  11         <type><ref refid="group__enum_1ga7d33eca9a5389952bdf719972eb802b6" kindref="member">closure_selector</ref></type>
  12         <declname>Close</declname>
  13         <defname>Close</defname>
  14       </param>
  15     </templateparamlist>
  16     <briefdescription>
  17 <para>View on a range, either closing it or leaving it as it is. </para>    </briefdescription>
  18     <detaileddescription>
  19 <para>The <ref refid="structboost_1_1geometry_1_1closeable__view" kindref="compound">closeable_view</ref> is used internally by the library to handle all rings, either closed or open, the same way. The default method is closed, all algorithms process rings as if they are closed. Therefore, if they are opened, a view is created which closes them. The <ref refid="structboost_1_1geometry_1_1closeable__view" kindref="compound">closeable_view</ref> might be used by library users, but its main purpose is internally. <parameterlist kind="templateparam"><parameteritem>
  20 <parameternamelist>
  21 <parametername>Range</parametername>
  22 </parameternamelist>
  23 <parameterdescription>
  24 <para>Original range </para></parameterdescription>
  25 </parameteritem>
  26 <parameteritem>
  27 <parameternamelist>
  28 <parametername>Close</parametername>
  29 </parameternamelist>
  30 <parameterdescription>
  31 <para>Specifies if it the range is closed, if so, nothing will happen. If it is open, it will iterate the first point after the last point. </para></parameterdescription>
  32 </parameteritem>
  33 </parameterlist>
  34 </para>    </detaileddescription>
  35     <location file="/home/ubuntu/boost/boost/geometry/views/closeable_view.hpp" line="81" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/views/closeable_view.hpp" bodystart="81" bodyend="81"/>
  36     <listofallmembers>
  37     </listofallmembers>
  38   </compounddef>
  39 </doxygen>