geometry/doc/doxygen_output/html/segment_8hpp_source.html
Barend Gehrels 363580fbf6 Added old doxygen docs
[SVN r59777]
2010-02-20 15:57:12 +00:00

172 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<table cellpadding="2" width="100%">
<tbody>
<tr>
<td valign="top">
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
&nbsp;&nbsp;
</td>
<td valign="top" align="right">
<a href="http://www.boost.org">
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
</a>
</td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>boost/geometry/geometries/segment.hpp</h1><a href="segment_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Boost.Geometry (aka GGL, Generic Geometry Library)</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Copyright Barend Gehrels 2007-2009, Geodan, Amsterdam, the Netherlands.</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright Bruno Lalande 2008, 2009</span>
<a name="l00005"></a>00005 <span class="comment">// Use, modification and distribution is subject to the Boost Software License,</span>
<a name="l00006"></a>00006 <span class="comment">// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00007"></a>00007 <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#ifndef BOOST_GEOMETRY_GEOMETRIES_SEGMENT_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GEOMETRY_GEOMETRIES_SEGMENT_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;cstddef&gt;</span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;boost/concept/assert.hpp&gt;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;boost/mpl/if.hpp&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;boost/type_traits/is_const.hpp&gt;</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;<a class="code" href="point__concept_8hpp.html">boost/geometry/geometries/concepts/point_concept.hpp</a>&gt;</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>geometry
<a name="l00021"></a>00021 {
<a name="l00022"></a>00022
<a name="l00036"></a>00036 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> ConstOrNonConstPo<span class="keywordtype">int</span>&gt;
<a name="l00037"></a><a class="code" href="classboost_1_1geometry_1_1segment.html">00037</a> <span class="keyword">class </span><a class="code" href="classboost_1_1geometry_1_1segment.html" title="Class segment: small class containing two (templatized) point references.">segment</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 BOOST_CONCEPT_ASSERT( (
<a name="l00040"></a>00040 <span class="keyword">typename</span> boost::mpl::if_
<a name="l00041"></a>00041 &lt;
<a name="l00042"></a>00042 boost::is_const&lt;ConstOrNonConstPoint&gt;,
<a name="l00043"></a>00043 <a class="code" href="classboost_1_1geometry_1_1concept_1_1_point.html" title="Point concept.">concept::Point&lt;ConstOrNonConstPoint&gt;</a>,
<a name="l00044"></a>00044 <a class="code" href="classboost_1_1geometry_1_1concept_1_1_const_point.html" title="point concept (const version)">concept::ConstPoint&lt;ConstOrNonConstPoint&gt;</a>
<a name="l00045"></a>00045 &gt;
<a name="l00046"></a>00046 ) );
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">typedef</span> ConstOrNonConstPoint <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="classboost_1_1geometry_1_1segment.html#7170a8e36aa8bd7f7aa2dcebc2030b7a">00052</a> <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>&amp; <a class="code" href="classboost_1_1geometry_1_1segment.html#7170a8e36aa8bd7f7aa2dcebc2030b7a">first</a>;
<a name="l00053"></a><a class="code" href="classboost_1_1geometry_1_1segment.html#76c17c6ea13a3f8c7c6792ae29f2e00b">00053</a> <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>&amp; <a class="code" href="classboost_1_1geometry_1_1segment.html#76c17c6ea13a3f8c7c6792ae29f2e00b">second</a>;
<a name="l00054"></a>00054
<a name="l00055"></a><a class="code" href="classboost_1_1geometry_1_1segment.html#a70dc90b895165025496d85ebdb161d4">00055</a> <span class="keyword">inline</span> <a class="code" href="classboost_1_1geometry_1_1segment.html#a70dc90b895165025496d85ebdb161d4">segment</a>(<a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>&amp; p1, <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>&amp; p2)
<a name="l00056"></a>00056 : <a class="code" href="classboost_1_1geometry_1_1segment.html#7170a8e36aa8bd7f7aa2dcebc2030b7a">first</a>(p1)
<a name="l00057"></a>00057 , <a class="code" href="classboost_1_1geometry_1_1segment.html#76c17c6ea13a3f8c7c6792ae29f2e00b">second</a>(p2)
<a name="l00058"></a>00058 {}
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// Traits specializations for segment above</span>
<a name="l00062"></a>00062 <span class="preprocessor">#ifndef DOXYGEN_NO_TRAITS_SPECIALIZATIONS</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="keyword">namespace </span>traits
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ConstOrNonConstPo<span class="keywordtype">int</span>&gt;
<a name="l00067"></a>00067 <span class="keyword">struct </span>tag&lt;segment&lt;ConstOrNonConstPoint&gt; &gt;
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keyword">typedef</span> segment_tag <a class="code" href="structboost_1_1geometry_1_1traits_1_1tag.html#e1d5ca3f8597416d2838511ed9265e23">type</a>;
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ConstOrNonConstPo<span class="keywordtype">int</span>&gt;
<a name="l00073"></a>00073 <span class="keyword">struct </span>point_type&lt;segment&lt;ConstOrNonConstPoint&gt; &gt;
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="keyword">typedef</span> ConstOrNonConstPoint type;
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ConstOrNonConstPo<span class="keywordtype">int</span>, std::<span class="keywordtype">size_t</span> Dimension&gt;
<a name="l00079"></a>00079 <span class="keyword">struct </span>indexed_access&lt;segment&lt;ConstOrNonConstPoint&gt;, 0, Dimension&gt;
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <span class="keyword">typedef</span> segment&lt;ConstOrNonConstPoint&gt; segment_type;
<a name="l00082"></a>00082 <span class="keyword">typedef</span> <span class="keyword">typename</span> geometry::coordinate_type&lt;segment_type&gt;::type coordinate_type;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">static</span> <span class="keyword">inline</span> coordinate_type <span class="keyword">get</span>(segment_type <span class="keyword">const</span>&amp; s)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 <span class="keywordflow">return</span> geometry::get&lt;Dimension&gt;(s.first);
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <span class="keyword">set</span>(segment_type&amp; s, coordinate_type <span class="keyword">const</span>&amp; value)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 geometry::set&lt;Dimension&gt;(s.first, value);
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ConstOrNonConstPo<span class="keywordtype">int</span>, std::<span class="keywordtype">size_t</span> Dimension&gt;
<a name="l00097"></a>00097 <span class="keyword">struct </span>indexed_access&lt;segment&lt;ConstOrNonConstPoint&gt;, 1, Dimension&gt;
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="keyword">typedef</span> segment&lt;ConstOrNonConstPoint&gt; segment_type;
<a name="l00100"></a>00100 <span class="keyword">typedef</span> <span class="keyword">typename</span> geometry::coordinate_type&lt;segment_type&gt;::type coordinate_type;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">static</span> <span class="keyword">inline</span> coordinate_type <span class="keyword">get</span>(segment_type <span class="keyword">const</span>&amp; s)
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 <span class="keywordflow">return</span> geometry::get&lt;Dimension&gt;(s.second);
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <span class="keyword">set</span>(segment_type&amp; s, coordinate_type <span class="keyword">const</span>&amp; value)
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 geometry::set&lt;Dimension&gt;(s.second, value);
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 };
<a name="l00112"></a>00112
<a name="l00113"></a>00113 } <span class="comment">// namespace traits</span>
<a name="l00114"></a>00114 <span class="preprocessor">#endif // DOXYGEN_NO_TRAITS_SPECIALIZATIONS</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span>
<a name="l00116"></a>00116 }} <span class="comment">// namespace boost::geometry</span>
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#endif // BOOST_GEOMETRY_GEOMETRIES_SEGMENT_HPP</span>
</pre></div></div>
<hr size="1">
<table width="100%">
<tbody>
<tr>
<td align="left"><small>
<p>December 1, 2009</p>
</small></td>
<td align="right">
<small>Copyright <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
Copyright <20> 2009 Mateusz Loskot, Cadcorp, London<br>
</small>
</td>
</tr>
</tbody>
</table>
<address style="text-align: right;"><small>
Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
</small></address>
</body>
</html>