71 lines
23 KiB
HTML
71 lines
23 KiB
HTML
<!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">GCellGrid.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <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> <span class="comment">// | |</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// | Author : Jean-Paul CHAPUT |</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// | E-mail : Jean-Paul.Chaput@lip6.fr |</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// | =============================================================== |</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// | C++ Header : "./katabatic/GCellGrid.h" |</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef KATABATIC_GCELL_GRID_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define KATABATIC_GCELL_GRID_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span><a class="code" href="namespaceHurricane.html">Hurricane</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">class </span>Cell;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "katabatic/Constants.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "katabatic/Grid.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "katabatic/GCell.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespaceKatabatic.html">Katabatic</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">using</span> <a class="codeRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Cell.html">Hurricane::Cell</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">using</span> Hurricane::_TName;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">class </span>KatabaticEngine;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// -------------------------------------------------------------------</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// Class : "Katabatic::GCellGrid".</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html"> 42</a></span>  <span class="keyword">class </span><a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a> : <span class="keyword">public</span> <a class="code" href="classKatabatic_1_1Grid.html">Grid</a><GCell> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fe"> 44</a></span>  <span class="keyword">enum</span> <a class="code" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fe">DensityMode</a> { AverageHVDensity=1 <span class="comment">// Average between all densities.</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40feaec0ad06385eae8d1e2dee4f3c9f9f4ed"> 45</a></span>  , AverageHDensity =2 <span class="comment">// Average between all H densities.</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fead1a1d89017d10aeb63d1c05b6fb650dd"> 46</a></span>  , AverageVDensity =3 <span class="comment">// Average between all V densities.</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fea8265e053af0708a508ecbce86d1a8165"> 47</a></span>  , MaxHVDensity =4 <span class="comment">// Maximum between average H and average V.</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fea5f0a89ca367ef98550eaa86c1e32c873"> 48</a></span>  , MaxVDensity =5 <span class="comment">// Maximum of V densities.</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fea2a6d29b012cc89026c3c0061f87a4f03"> 49</a></span>  , MaxHDensity =6 <span class="comment">// Maximum of H densities.</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fea90a2f4a4ee8558de9f99458ddeab852c"> 50</a></span>  , MaxDensity =7 <span class="comment">// Maximum of H & V densities.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  };</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="codeRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Cell.html">Cell</a>* getCell () <span class="keyword">const</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">inline</span> <a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>* getKatabatic () <span class="keyword">const</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getDensityMode () <span class="keyword">const</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> getHEdgeCapacity () <span class="keyword">const</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> getVEdgeCapacity () <span class="keyword">const</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="codeRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Interval.html">Interval</a> getUSide ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ) <span class="keyword">const</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">size_t</span> checkDensity () <span class="keyword">const</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> checkEdgeOverflow ( <span class="keywordtype">size_t</span> hreserved, <span class="keywordtype">size_t</span> vreserved ) <span class="keyword">const</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">size_t</span> updateDensity ();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> updateContacts ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags=KbOpenSession );</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> setDensityMode ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> );</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> _xmlWrite ( ostream& );</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> Record* _getRecord () <span class="keyword">const</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">virtual</span> <span class="keywordtype">string</span> _getString () <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <span class="keywordtype">string</span> _getTypeName () <span class="keyword">const</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Attributes.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>* _katabatic;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">int</span> _densityMode;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">size_t</span> _hEdgeCapacity;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">size_t</span> _vEdgeCapacity;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// Constructors & Destructors.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a> ( <a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>* );</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> ~<a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a> ();</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> _postCreate ();</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> _preDestroy ();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">static</span> <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a>* create ( <a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>* );</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">private</span>: </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a> ( <span class="keyword">const</span> <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a>& );</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a>& operator= ( <span class="keyword">const</span> <a class="code" href="classKatabatic_1_1GCellGrid.html">GCellGrid</a>& );</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// Friends.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  };</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a0234fdabe7682546f1201bccd0b5cacf"> 93</a></span>  <span class="keyword">inline</span> <a class="code" href="classKatabatic_1_1KatabaticEngine.html">KatabaticEngine</a>* GCellGrid::getKatabatic ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _katabatic; }</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#af1171855a3e928cace78d1534a8d0629"> 94</a></span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GCellGrid::getDensityMode ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _densityMode; }</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a041680c5d171d4c7cb0edba96f0c390f"> 95</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> GCellGrid::getHEdgeCapacity ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _hEdgeCapacity; }</div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#ae8e2cf3685ccb0621f4f85c7999834e8"> 96</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> GCellGrid::getVEdgeCapacity ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _vEdgeCapacity; }</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classKatabatic_1_1GCellGrid.html#a86899930041463cf80b713c3ca5b4834"> 97</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> GCellGrid::setDensityMode ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mode ) { _densityMode=mode; }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <span class="comment">// End of Katabatic namespace.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> INSPECTOR_P_SUPPORT(<a class="code" href="classKatabatic_1_1GCellGrid.html">Katabatic::GCellGrid</a>);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif // __KATABATIC_GCELL_GRID__</span></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="classHurricane_1_1Cell_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Cell.html">Hurricane::Cell</a></div></div>
|
|
<div class="ttc" id="classHurricane_1_1Interval_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Interval.html">Hurricane::Interval</a></div></div>
|
|
<div class="ttc" id="classKatabatic_1_1GCellGrid_html"><div class="ttname"><a href="classKatabatic_1_1GCellGrid.html">Katabatic::GCellGrid</a></div><div class="ttdoc">GCell Grid. </div><div class="ttdef"><b>Definition:</b> GCellGrid.h:42</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="classKatabatic_1_1KatabaticEngine_html"><div class="ttname"><a href="classKatabatic_1_1KatabaticEngine.html">Katabatic::KatabaticEngine</a></div><div class="ttdoc">The Katabatic Tool. </div><div class="ttdef"><b>Definition:</b> KatabaticEngine.h:91</div></div>
|
|
<div class="ttc" id="classKatabatic_1_1GCellGrid_html_a07884f5e1af410e98208fed76a2b40fe"><div class="ttname"><a href="classKatabatic_1_1GCellGrid.html#a07884f5e1af410e98208fed76a2b40fe">Katabatic::GCellGrid::DensityMode</a></div><div class="ttdeci">DensityMode</div><div class="ttdef"><b>Definition:</b> GCellGrid.h:44</div></div>
|
|
<div class="ttc" id="namespaceHurricane_html"><div class="ttname"><a href="namespaceHurricane.html">Hurricane</a></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 © 2008-2016 UPMC. All rights reserved</small></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|