libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1d2_1_1point__xy.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="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy" kind="class" prot="public">
   4     <compoundname>boost::geometry::model::d2::point_xy</compoundname>
   5     <basecompoundref refid="classboost_1_1geometry_1_1model_1_1point" prot="public" virt="non-virtual">boost::geometry::model::point&lt; CoordinateType, 2, CoordinateSystem &gt;</basecompoundref>
   6     <includes local="no">point_xy.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename</type>
  10         <declname>CoordinateType</declname>
  11         <defname>CoordinateType</defname>
  12       </param>
  13       <param>
  14         <type>typename</type>
  15         <declname>CoordinateSystem</declname>
  16         <defname>CoordinateSystem</defname>
  17         <defval><ref refid="structboost_1_1geometry_1_1cs_1_1cartesian" kindref="compound">cs::cartesian</ref></defval>
  18       </param>
  19     </templateparamlist>
  20       <sectiondef kind="public-func">
  21       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a69609f33908550b343e653291b836d78" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  22         <type></type>
  23         <definition>boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::point_xy</definition>
  24         <argsstring>()=default</argsstring>
  25         <name>point_xy</name>
  26         <briefdescription>
  27 <para>Default constructor, no initialization. </para>        </briefdescription>
  28         <detaileddescription>
  29         </detaileddescription>
  30         <inbodydescription>
  31         </inbodydescription>
  32         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="52" column="1"/>
  33       </memberdef>
  34       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1afc05f085ae9675c83aadbd7026a1be0a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  35         <type></type>
  36         <definition>boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::point_xy</definition>
  37         <argsstring>(CoordinateType const &amp;x, CoordinateType const &amp;y)</argsstring>
  38         <name>point_xy</name>
  39         <param>
  40           <type>CoordinateType const &amp;</type>
  41           <declname>x</declname>
  42         </param>
  43         <param>
  44           <type>CoordinateType const &amp;</type>
  45           <declname>y</declname>
  46         </param>
  47         <briefdescription>
  48 <para>Constructor with x/y values. </para>        </briefdescription>
  49         <detaileddescription>
  50         </detaileddescription>
  51         <inbodydescription>
  52         </inbodydescription>
  53         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="60" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="60" bodyend="62"/>
  54       </memberdef>
  55       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1aa023762716f30c1887fe062e06572238" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
  56         <type>CoordinateType const &amp;</type>
  57         <definition>CoordinateType const&amp; boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::x</definition>
  58         <argsstring>() const </argsstring>
  59         <name>x</name>
  60         <briefdescription>
  61 <para>Get x-value. </para>        </briefdescription>
  62         <detaileddescription>
  63         </detaileddescription>
  64         <inbodydescription>
  65         </inbodydescription>
  66         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="65" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="65" bodyend="66"/>
  67       </memberdef>
  68       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a89ca091e60b57bc097c0292763a52a59" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  69         <type>void</type>
  70         <definition>void boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::x</definition>
  71         <argsstring>(CoordinateType const &amp;v)</argsstring>
  72         <name>x</name>
  73         <param>
  74           <type>CoordinateType const &amp;</type>
  75           <declname>v</declname>
  76         </param>
  77         <briefdescription>
  78 <para>Set x-value. </para>        </briefdescription>
  79         <detaileddescription>
  80         </detaileddescription>
  81         <inbodydescription>
  82         </inbodydescription>
  83         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="73" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="73" bodyend="74"/>
  84       </memberdef>
  85       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a3799460788a157cbef0f690006e65744" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
  86         <type>CoordinateType const &amp;</type>
  87         <definition>CoordinateType const&amp; boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::y</definition>
  88         <argsstring>() const </argsstring>
  89         <name>y</name>
  90         <briefdescription>
  91 <para>Get y-value. </para>        </briefdescription>
  92         <detaileddescription>
  93         </detaileddescription>
  94         <inbodydescription>
  95         </inbodydescription>
  96         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="69" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="69" bodyend="70"/>
  97       </memberdef>
  98       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1af0d8f7cc38a4bf2e385bf90a786a1057" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  99         <type>void</type>
 100         <definition>void boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;::y</definition>
 101         <argsstring>(CoordinateType const &amp;v)</argsstring>
 102         <name>y</name>
 103         <param>
 104           <type>CoordinateType const &amp;</type>
 105           <declname>v</declname>
 106         </param>
 107         <briefdescription>
 108 <para>Set y-value. </para>        </briefdescription>
 109         <detaileddescription>
 110         </detaileddescription>
 111         <inbodydescription>
 112         </inbodydescription>
 113         <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="77" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="77" bodyend="78"/>
 114       </memberdef>
 115       </sectiondef>
 116     <briefdescription>
 117 <para>2D point in Cartesian coordinate system </para>    </briefdescription>
 118     <detaileddescription>
 119 <para><parameterlist kind="templateparam"><parameteritem>
 120 <parameternamelist>
 121 <parametername>CoordinateType</parametername>
 122 </parameternamelist>
 123 <parameterdescription>
 124 <para>numeric type, for example, double, float, int </para></parameterdescription>
 125 </parameteritem>
 126 <parameteritem>
 127 <parameternamelist>
 128 <parametername>CoordinateSystem</parametername>
 129 </parameternamelist>
 130 <parameterdescription>
 131 <para>coordinate system, defaults to <ref refid="structboost_1_1geometry_1_1cs_1_1cartesian" kindref="compound">cs::cartesian</ref></para></parameterdescription>
 132 </parameteritem>
 133 </parameterlist>
 134  <qbk>[include reference/geometries/point_xy.qbk]</qbk>   <qbk.before.synopsis>
 135 [heading Model of]
 136 [link geometry.reference.concepts.concept_point Point Concept]
 137 </qbk.before.synopsis> </para><para> <qbk>[include reference/geometries/point_assign_warning.qbk]</qbk>  </para>    </detaileddescription>
 138     <inheritancegraph>
 139       <node id="481">
 140         <label>boost::geometry::model::point&lt; CoordinateType, 2, CoordinateSystem &gt;</label>
 141         <link refid="classboost_1_1geometry_1_1model_1_1point"/>
 142       </node>
 143       <node id="480">
 144         <label>boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;</label>
 145         <link refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy"/>
 146         <childnode refid="481" relation="public-inheritance">
 147         </childnode>
 148       </node>
 149     </inheritancegraph>
 150     <collaborationgraph>
 151       <node id="483">
 152         <label>boost::geometry::model::point&lt; CoordinateType, 2, CoordinateSystem &gt;</label>
 153         <link refid="classboost_1_1geometry_1_1model_1_1point"/>
 154       </node>
 155       <node id="482">
 156         <label>boost::geometry::model::d2::point_xy&lt; CoordinateType, CoordinateSystem &gt;</label>
 157         <link refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy"/>
 158         <childnode refid="483" relation="public-inheritance">
 159         </childnode>
 160       </node>
 161     </collaborationgraph>
 162     <location file="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" line="47" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/point_xy.hpp" bodystart="46" bodyend="79"/>
 163     <listofallmembers>
 164       <member refid="classboost_1_1geometry_1_1model_1_1point_1a5042d74b21e525743168c56563ddf015" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>get</name></member>
 165       <member refid="classboost_1_1geometry_1_1model_1_1point_1a768fcbb0028e80ee4579a47f5d058370" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point</name></member>
 166       <member refid="classboost_1_1geometry_1_1model_1_1point_1a0236fd6973659285b15292d9370e9136" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point</name></member>
 167       <member refid="classboost_1_1geometry_1_1model_1_1point_1abe00d79aa3ed9be100f1a34b7d09249b" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point</name></member>
 168       <member refid="classboost_1_1geometry_1_1model_1_1point_1a2d74ab12275dd09e47b50ab941f71e58" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point</name></member>
 169       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a69609f33908550b343e653291b836d78" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point_xy</name></member>
 170       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1afc05f085ae9675c83aadbd7026a1be0a" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>point_xy</name></member>
 171       <member refid="classboost_1_1geometry_1_1model_1_1point_1adc88778b0d7c9e70aeeed0981c003a67" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>set</name></member>
 172       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1aa023762716f30c1887fe062e06572238" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>x</name></member>
 173       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a89ca091e60b57bc097c0292763a52a59" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>x</name></member>
 174       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1a3799460788a157cbef0f690006e65744" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>y</name></member>
 175       <member refid="classboost_1_1geometry_1_1model_1_1d2_1_1point__xy_1af0d8f7cc38a4bf2e385bf90a786a1057" prot="public" virt="non-virtual"><scope>boost::geometry::model::d2::point_xy</scope><name>y</name></member>
 176     </listofallmembers>
 177   </compounddef>
 178 </doxygen>