libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/structboost_1_1geometry_1_1add__const__if__c.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36   <div id="navrow2" class="tabs2">
  37     <ul class="tablist">
  38       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  40       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  41       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42     </ul>
  43   </div>
  44 <div id="nav-path" class="navpath">
  45   <ul>
  46 <li class="navelem"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></li><li class="navelem"><a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html">add_const_if_c</a></li>  </ul>
  47 </div>
  48 </div><!-- top -->
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#pub-types">Public Types</a> &#124;
  52 <a href="structboost_1_1geometry_1_1add__const__if__c-members.html">List of all members</a>  </div>
  53   <div class="headertitle">
  54 <div class="title">boost::geometry::add_const_if_c&lt; IsConst, Type &gt; Struct Template Reference</div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57
  58 <p>Meta-function to define a const or non const type.
  59  <a href="structboost_1_1geometry_1_1add__const__if__c.html#details">More...</a></p>
  60 <table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  62 Public Types</h2></td></tr>
  63 <tr class="memitem:a7adfc69ab7628a0884a19166a3c681a9"><td class="memItemLeft" align="right" valign="top">typedef boost::mpl::if_c<br class="typebreak"/>
  64 &lt; IsConst, Type const, Type &gt;<br class="typebreak"/>
  65 ::<a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html#a7adfc69ab7628a0884a19166a3c681a9">type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html#a7adfc69ab7628a0884a19166a3c681a9">type</a></td></tr>
  66 <tr class="separator:a7adfc69ab7628a0884a19166a3c681a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 </table>
  68 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  69 <div class="textblock"><h3>template&lt;bool IsConst, typename Type&gt;<br/>
  70 struct boost::geometry::add_const_if_c&lt; IsConst, Type &gt;</h3>
  71
  72 <p>Meta-function to define a const or non const type. </p>
  73 <p>If the boolean template parameter is true, the type parameter will be defined as const, otherwise it will be defined as it was. This meta-function is used to have one implementation for both const and non const references </p>
  74 <dl class="section note"><dt>Note</dt><dd>This traits class is completely independant from Boost.Geometry and might be a separate addition to Boost </dd>
  75 <dd>
  76 Used in a.o. for_each, interior_rings, exterior_ring </dd></dl>
  77 <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">void</span> foo(<span class="keyword">typename</span> add_const_if_c&lt;IsConst, Point&gt;::type&amp; point)</div>
  78 </div><!-- fragment --> </dd></dl>
  79 </div><h2 class="groupheader">Member Typedef Documentation</h2>
  80 <a class="anchor" id="a7adfc69ab7628a0884a19166a3c681a9"></a>
  81 <div class="memitem">
  82 <div class="memproto">
  83 <div class="memtemplate">
  84 template&lt;bool IsConst, typename Type &gt; </div>
  85       <table class="memname">
  86         <tr>
  87           <td class="memname">typedef boost::mpl::if_c&lt; IsConst, Type const, Type &gt;::<a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html#a7adfc69ab7628a0884a19166a3c681a9">type</a> <a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html">boost::geometry::add_const_if_c</a>&lt; IsConst, Type &gt;::<a class="el" href="structboost_1_1geometry_1_1add__const__if__c.html#a7adfc69ab7628a0884a19166a3c681a9">type</a></td>
  88         </tr>
  89       </table>
  90 </div><div class="memdoc">
  91
  92 </div>
  93 </div>
  94 </div><!-- contents -->
  95 <hr size="1">
  96 <table width="100%">
  97 <tbody>
  98 <tr>
  99 <td align="left"><small>
 100 <p>April 2, 2011</p>
 101 </small></td>
 102 <td align="right">
 103 <small>
 104 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 105 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 106 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 107 </small>
 108 </td>
 109 </tr>
 110 </tbody>
 111 </table>
 112 <address style="text-align: right;"><small>
 113 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 114 </small></address>
 115 </body>
 116 </html>