jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
coriolis/katabatic/doc/html/Grid_8h_source.html

91 lines
77 KiB
HTML
Raw Normal View History

Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Katabatic Documentation</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="SoC.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<h1 id="pagetop" class="header">Katabatic - Routing Toolbox</h1>
<!--
<center class="header">
<table class="header">
<tr>
<td><a href="customSummary.html">Summary</a></td>
<td><a href="namespaces.html">Namespaces</a></td>
<td><a href="customHierarchy.html">Class Hierarchy</a></td>
<td><a href="annotated.html">Classes</a></td>
<td><a href="functions.html">Member Index</a></td>
</tr>
</table>
</center>
-->
<br>
<body onload="javascript:toggleLevel(1)">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_46a5d811a0c60e95b7acaa92d73c003a.html">katabatic</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Grid.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// This file is part of the Coriolis Software.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright (c) UPMC 2008-2018, All Rights Reserved</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// | C O R I O L I S |</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// | K a t a b a t i c - Routing Toolbox |</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// | |</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// | Author : Jean-Paul CHAPUT |</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// | E-mail : Jean-Paul.Chaput@lip6.fr |</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// | =============================================================== |</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// | C++ Header : &quot;./katabatic/Grid.h&quot; |</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef KATABATIC_GRID_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define KATABATIC_GRID_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;hurricane/Point.h&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;hurricane/Box.h&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;hurricane/Collection.h&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceKatabatic.html">Katabatic</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><d
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a4bad6abc58473d953258a3230506291a"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a4bad6abc58473d953258a3230506291a">Katabatic::BaseGrid::getRows</a></div><div class="ttdeci">unsigned int getRows() const</div><div class="ttdef"><b>Definition:</b> Grid.h:118</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html_a47fdc9eea42b6975cdc835bb2e08810e"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html#a47fdc9eea42b6975cdc835bb2e08810e">Katabatic::BaseGrid::Axis::sort</a></div><div class="ttdeci">void sort()</div><div class="ttdef"><b>Definition:</b> Grid.cpp:36</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html_ada526136545060f41e8b9228ce1c5895"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html#ada526136545060f41e8b9228ce1c5895">Katabatic::BaseGrid::Axis::addGraduation</a></div><div class="ttdeci">void addGraduation(DbU::Unit)</div><div class="ttdef"><b>Definition:</b> Grid.h:110</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html">Katabatic::BaseGrid</a></div><div class="ttdoc">Abstract Base Class for Irregular Grid. </div><div class="ttdef"><b>Definition:</b> Grid.h:44</div></div>
<div class="ttc" id="classKatabatic_1_1Grid_html"><div class="ttname"><a href="classKatabatic_1_1Grid.html">Katabatic::Grid</a></div><div class="ttdoc">Template Class for Regular Grid. </div><div class="ttdef"><b>Definition:</b> Grid.h:136</div></div>
<div class="ttc" id="group__DbUGroup_html_ga4fbfa3e8c89347af76c9628ea06c4146"><div class="ttname"><a href="../hurricane/group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Hurricane::DbU::Unit</a></div><div class="ttdeci">std::int64_t Unit</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a1e3eea49f6f58fb8d0b3fa73f5cf3fd7"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a1e3eea49f6f58fb8d0b3fa73f5cf3fd7">Katabatic::BaseGrid::getXGrads</a></div><div class="ttdeci">const Axis &amp; getXGrads() const</div><div class="ttdef"><b>Definition:</b> Grid.h:126</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html_a2a6bd524227130d8ccf482aa2c484a42"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html#a2a6bd524227130d8ccf482aa2c484a42">Katabatic::BaseGrid::Axis::getGraduationNumber</a></div><div class="ttdeci">unsigned int getGraduationNumber(DbU::Unit pos, bool &amp;onGraduation) const</div><div class="ttdef"><b>Definition:</b> Grid.cpp:42</div></div>
<div class="ttc" id="classHurricane_1_1Point_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Point.html">Hurricane::Point</a></div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a4b6cf5a28d88d7ad3e6ddeac28a35a0b"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a4b6cf5a28d88d7ad3e6ddeac28a35a0b">Katabatic::BaseGrid::getBoundingBox</a></div><div class="ttdeci">const Box &amp; getBoundingBox() const</div><div class="ttdef"><b>Definition:</b> Grid.h:116</div></div>
<div class="ttc" id="group__DbUGroup_html_gga6af6a5b8d113a661fea65b2bcb8b25c4ac6b6574b2ef79ee4e44c6c00fe757c7c"><div class="ttname"><a href="../hurricane/group__DbUGroup.html#gga6af6a5b8d113a661fea65b2bcb8b25c4ac6b6574b2ef79ee4e44c6c00fe757c7c">Grid</a></div><div class="ttdeci">Grid</div></div>
<div class="ttc" id="classHurricane_1_1GenericCollection_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1GenericCollection.html">Hurricane::GenericCollection</a></div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_ac479157e8ac115074615167e8a4a2789"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#ac479157e8ac115074615167e8a4a2789">Katabatic::BaseGrid::BaseGrid</a></div><div class="ttdeci">BaseGrid(const Box &amp;)</div><div class="ttdef"><b>Definition:</b> Grid.cpp:99</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a3a80b6032f86a56bec74609034b3246f"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a3a80b6032f86a56bec74609034b3246f">Katabatic::BaseGrid::destroy</a></div><div class="ttdeci">void destroy()</div><div class="ttdef"><b>Definition:</b> Grid.h:115</div></div>
<div class="ttc" id="namespaceKatabatic_html"><div class="ttname"><a href="namespaceKatabatic.html">Katabatic</a></div><div class="ttdoc">The namespace dedicated to Katabatic. </div><div class="ttdef"><b>Definition:</b> Katabatic.dox:13</div></div>
<div class="ttc" id="classHurricane_1_1Box_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Box.html">Hurricane::Box</a></div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a47cf844f090417180d0bae098133565e"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a47cf844f090417180d0bae098133565e">Katabatic::BaseGrid::getRawSize</a></div><div class="ttdeci">unsigned int getRawSize() const</div><div class="ttdef"><b>Definition:</b> Grid.h:119</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a21a8582c0c89a61d1963262fa053bc1b"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a21a8582c0c89a61d1963262fa053bc1b">Katabatic::BaseGrid::getColumn</a></div><div class="ttdeci">unsigned int getColumn(unsigned int) const</div><div class="ttdef"><b>Definition:</b> Grid.h:122</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_a8108a276ab72226244d302fb1b59f3f1"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#a8108a276ab72226244d302fb1b59f3f1">Katabatic::BaseGrid::getRow</a></div><div class="ttdeci">unsigned int getRow(unsigned int) const</div><div class="ttdef"><b>Definition:</b> Grid.h:121</div></div>
<div class="ttc" id="classHurricane_1_1DbU_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1DbU.html">Hurricane::DbU</a></div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_ab11d8b83eaa19f5fe6fecc63a8bb203e"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#ab11d8b83eaa19f5fe6fecc63a8bb203e">Katabatic::BaseGrid::getYGrads</a></div><div class="ttdeci">const Axis &amp; getYGrads() const</div><div class="ttdef"><b>Definition:</b> Grid.h:127</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html_a9be1e4285daa77fe397767c097fbdc66"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html#a9be1e4285daa77fe397767c097fbdc66">Katabatic::BaseGrid::Axis::getSize</a></div><div class="ttdeci">unsigned int getSize() const</div><div class="ttdef"><b>Definition:</b> Grid.h:111</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html">Katabatic::BaseGrid::Axis</a></div><div class="ttdoc">Graduations on a BaseGrid Axis (H or V). </div><div class="ttdef"><b>Definition:</b> Grid.h:68</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_aeaf0dae788f4c997e6172f9c734e3a91"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">Katabatic::BaseGrid::getColumns</a></div><div class="ttdeci">unsigned int getColumns() const</div><div class="ttdef"><b>Definition:</b> Grid.h:117</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_1_1Axis_html_a074a4f61306b88baac6bbf54b0b3212c"><div class="ttname"><a href="classKatabatic_1_1BaseGrid_1_1Axis.html#a074a4f61306b88baac6bbf54b0b3212c">Katabatic::BaseGrid::Axis::operator[]</a></div><div class="ttdeci">const DbU::Unit &amp; operator[](unsigned int i) const</div><div class="ttdef"><b>Definition:</b> Grid.h:112</div></div>
<div class="ttc" id="classKatabatic_1_1BaseGrid_html_aae84726d9984c1df9905fc97d9b34f28"><div class="ttname"><a href="classKatabatic_1_1BaseGrid.html#aae84726d9984c1df9905fc97d9b34f28">Katabatic::BaseGrid::getIndex</a></div><div class="ttdeci">unsigned int getIndex(unsigned int c, unsigned int r) const</div><div class="ttdef"><b>Definition:</b> Grid.h:120</div></div>
<div class="ttc" id="classKatabatic_1_1Grid_html_a1b772cc784f7110caca47acb76dcec62"><div class="ttname"><a href="classKatabatic_1_1Grid.html#a1b772cc784f7110caca47acb76dcec62">Katabatic::Grid::Grid</a></div><div class="ttdeci">Grid(const Box &amp;)</div><div class="ttdef"><b>Definition:</b> Grid.h:186</div></div>
</div><!-- fragment --></div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.13 on Mon May 14 2018</small></td>
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
</tr>
</table>
<table class="footer2">
<tr>
<td class="LFooter">Katabatic - Routing Toolbox</td>
<td class="RFooter"><small>Copyright &#169; 2008-2016 UPMC. All rights reserved</small></td>
</tr>
</table>
</body>
</html>