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

95 lines
44 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>Kite - Detailed Router</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">Kite - Detailed Router</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_2916ee297f5e79ec495d393dfe8ba769.html">kite</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">RoutingPlane.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-2013, 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 i t e - D e t a i l e d R o u t e r |</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@asim.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;./kite/RoutingPlane.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 KITE_ROUTING_PLANE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define KITE_ROUTING_PLANE_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 &quot;crlcore/RoutingLayerGauge.h&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;kite/Track.h&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceKite.html">Kite</a> {</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; <span class="keyword">using</span> <a class="codeRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/crlcore/doc/crlcore/html/crlcore.tag:../crlcore/" href="../crlcore/classCRL_1_1RoutingLayerGauge.html">CRL::RoutingLayerGauge</a>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">using</span> Katabatic::Kb
<div class="ttc" id="classKite_1_1RoutingPlane_html_abd54544ef1710ee4b67cfb021d73446c"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#abd54544ef1710ee4b67cfb021d73446c">Kite::RoutingPlane::isVertical</a></div><div class="ttdeci">bool isVertical() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:117</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_ab045567c4f529dca7790d66c17c3084f"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#ab045567c4f529dca7790d66c17c3084f">Kite::RoutingPlane::getLayer</a></div><div class="ttdeci">const Layer * getLayer() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:103</div></div>
<div class="ttc" id="classCRL_1_1RoutingLayerGauge_html_a7e024262e549b6109b720c07e28ab16c"><div class="ttname"><a href="../crlcore/classCRL_1_1RoutingLayerGauge.html#a7e024262e549b6109b720c07e28ab16c">CRL::RoutingLayerGauge::getLayer</a></div><div class="ttdeci">const Layer * getLayer() const</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a4e47dfca4bfafa56d9c0f1dc39dc237e"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a4e47dfca4bfafa56d9c0f1dc39dc237e">Kite::RoutingPlane::getBlockageLayer</a></div><div class="ttdeci">const Layer * getBlockageLayer() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:104</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_aa44eb6d4806e49d36bf273cd9d979197"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#aa44eb6d4806e49d36bf273cd9d979197">Kite::RoutingPlane::getTracksSize</a></div><div class="ttdeci">size_t getTracksSize() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:105</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a7478ed4841ef25190c021165dd457520"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a7478ed4841ef25190c021165dd457520">Kite::RoutingPlane::getBottom</a></div><div class="ttdeci">RoutingPlane * getBottom() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:150</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a91d1fdb3aac133a9f687207499caf1c4"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a91d1fdb3aac133a9f687207499caf1c4">Kite::RoutingPlane::create</a></div><div class="ttdeci">static RoutingPlane * create(KiteEngine *, size_t depth)</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:91</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="classKite_1_1RoutingPlane_html_aeea9a19f9b402ffe42c011c9afc2ca73"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#aeea9a19f9b402ffe42c011c9afc2ca73">Kite::RoutingPlane::_check</a></div><div class="ttdeci">bool _check(unsigned int &amp;overlaps) const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:174</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a21b9cefd33ae22e4c2070ad441bdd30b"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a21b9cefd33ae22e4c2070ad441bdd30b">Kite::RoutingPlane::isHorizontal</a></div><div class="ttdeci">bool isHorizontal() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:114</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_af7373bd3a4ee8fcf28a316230ed37fc0"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#af7373bd3a4ee8fcf28a316230ed37fc0">Kite::RoutingPlane::getKiteEngine</a></div><div class="ttdeci">KiteEngine * getKiteEngine() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:95</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a5a0f37c5727c0d5bf286ed79b7143989"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a5a0f37c5727c0d5bf286ed79b7143989">Kite::RoutingPlane::getTrackMax</a></div><div class="ttdeci">DbU::Unit getTrackMax() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:102</div></div>
<div class="ttc" id="classKite_1_1Track_html"><div class="ttname"><a href="classKite_1_1Track.html">Kite::Track</a></div><div class="ttdoc">Structure managing one routing track. </div><div class="ttdef"><b>Definition:</b> Track.h:42</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_afd185bba655c6f59e11b5652352cb902"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#afd185bba655c6f59e11b5652352cb902">Kite::RoutingPlane::getTrackMin</a></div><div class="ttdeci">DbU::Unit getTrackMin() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:101</div></div>
<div class="ttc" id="classCRL_1_1RoutingLayerGauge_html_aa6c48e5acc6985997aa0417ef614f69d"><div class="ttname"><a href="../crlcore/classCRL_1_1RoutingLayerGauge.html#aa6c48e5acc6985997aa0417ef614f69d">CRL::RoutingLayerGauge::getBlockageLayer</a></div><div class="ttdeci">const Layer * getBlockageLayer() const</div></div>
<div class="ttc" id="classKite_1_1KiteEngine_html"><div class="ttname"><a href="classKite_1_1KiteEngine.html">Kite::KiteEngine</a></div><div class="ttdoc">The Kite Tool. </div><div class="ttdef"><b>Definition:</b> KiteEngine.h:60</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_ae2ea9830bfcd3d7f36af63bcad3eed6e"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#ae2ea9830bfcd3d7f36af63bcad3eed6e">Kite::RoutingPlane::getTrackPosition</a></div><div class="ttdeci">DbU::Unit getTrackPosition(size_t index) const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:111</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a8c464eebfa0f85d0b9f4677bb191100c"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a8c464eebfa0f85d0b9f4677bb191100c">Kite::RoutingPlane::getTrackByPosition</a></div><div class="ttdeci">Track * getTrackByPosition(DbU::Unit axis, unsigned int mode=KtNearest) const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:164</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a9adcc1428480dd9a60454637c704207f"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a9adcc1428480dd9a60454637c704207f">Kite::RoutingPlane::getAxisMin</a></div><div class="ttdeci">DbU::Unit getAxisMin() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:99</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a1aa9568c234ed8b055c54f73c262690d"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a1aa9568c234ed8b055c54f73c262690d">Kite::RoutingPlane::getAxisMax</a></div><div class="ttdeci">DbU::Unit getAxisMax() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:100</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_ae0b0e4f62672b952af5ba448e7fe4810"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#ae0b0e4f62672b952af5ba448e7fe4810">Kite::RoutingPlane::getLayerGauge</a></div><div class="ttdeci">RoutingLayerGauge * getLayerGauge() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:96</div></div>
<div class="ttc" id="classHurricane_1_1Layer_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Layer.html">Hurricane::Layer</a></div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html"><div class="ttname"><a href="classKite_1_1RoutingPlane.html">Kite::RoutingPlane</a></div><div class="ttdoc">Array of Tracks in one Layer. </div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:34</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a4b4c6bb50297d585962d84b2a165e139"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a4b4c6bb50297d585962d84b2a165e139">Kite::RoutingPlane::computeTracksSize</a></div><div class="ttdeci">size_t computeTracksSize() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:108</div></div>
<div class="ttc" id="classKite_1_1Track_html_ab5b5aaa5b318369feee6003dbad039c2"><div class="ttname"><a href="classKite_1_1Track.html#ab5b5aaa5b318369feee6003dbad039c2">Kite::Track::getAxis</a></div><div class="ttdeci">DbU::Unit getAxis() const</div><div class="ttdef"><b>Definition:</b> Track.h:192</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a1c9c37c39d0eb83b0b4279e3e54e24a5"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a1c9c37c39d0eb83b0b4279e3e54e24a5">Kite::RoutingPlane::getDepth</a></div><div class="ttdeci">size_t getDepth() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.h:98</div></div>
<div class="ttc" id="namespaceKite_html_acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada"><div class="ttname"><a href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada">Kite::KtNearest</a></div><div class="ttdef"><b>Definition:</b> Constants.h:41</div></div>
<div class="ttc" id="namespaceKite_html"><div class="ttname"><a href="namespaceKite.html">Kite</a></div><div class="ttdoc">The namespace dedicated to Kite. </div><div class="ttdef"><b>Definition:</b> Constants.h:22</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a855e69cd11c46df8c37843f25cabee05"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a855e69cd11c46df8c37843f25cabee05">Kite::RoutingPlane::getTop</a></div><div class="ttdeci">RoutingPlane * getTop() const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:146</div></div>
<div class="ttc" id="classKite_1_1RoutingPlane_html_a5e9defabb4cb2cb1b0f73b1dc3c677de"><div class="ttname"><a href="classKite_1_1RoutingPlane.html#a5e9defabb4cb2cb1b0f73b1dc3c677de">Kite::RoutingPlane::getTrackByIndex</a></div><div class="ttdeci">Track * getTrackByIndex(size_t index) const</div><div class="ttdef"><b>Definition:</b> RoutingPlane.cpp:157</div></div>
<div class="ttc" id="classCRL_1_1RoutingLayerGauge_html"><div class="ttname"><a href="../crlcore/classCRL_1_1RoutingLayerGauge.html">CRL::RoutingLayerGauge</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">Kite - Detailed Router</td>
<td class="RFooter"><small>Copyright &#169; 2008-2016 UPMC. All rights reserved</small></td>
</tr>
</table>
</body>
</html>