coriolis/kite/doc/html/namespaceKite.html

214 lines
20 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>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.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Kite Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The namespace dedicated to <a class="el" href="namespaceKite.html" title="The namespace dedicated to Kite. ">Kite</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1DataNegociate.html">DataNegociate</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Algorimthmic datas associated the <a class="el" href="classKite_1_1TrackSegment.html" title="Derived Katabatic::AutoSegment for the router. ">TrackSegment</a>. <a href="classKite_1_1DataNegociate.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1HorizontalTrack.html">HorizontalTrack</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Horizontal track managment. <a href="classKite_1_1HorizontalTrack.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1KiteEngine.html">KiteEngine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="namespaceKite.html" title="The namespace dedicated to Kite. ">Kite</a> Tool. <a href="classKite_1_1KiteEngine.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1Manipulator.html">Manipulator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle <a class="el" href="classKite_1_1TrackElement.html" title="Abstract Class for all Elements inserted inside a Track. ">TrackElement</a> ripup &amp; topological modifications. <a href="classKite_1_1Manipulator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1NegociateWindow.html">NegociateWindow</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform the routing, main <a class="el" href="classKite_1_1RoutingEvent.html" title="Atomic Placement Request for a TrackSegment. ">RoutingEvent</a> manager. <a href="classKite_1_1NegociateWindow.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1RoutingEvent.html">RoutingEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomic Placement Request for a <a class="el" href="classKite_1_1TrackSegment.html" title="Derived Katabatic::AutoSegment for the router. ">TrackSegment</a>. <a href="classKite_1_1RoutingEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1RoutingEventHistory.html">RoutingEventHistory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">History of <a class="el" href="classKite_1_1RoutingEvent.html" title="Atomic Placement Request for a TrackSegment. ">RoutingEvent</a>. <a href="classKite_1_1RoutingEventHistory.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1RoutingEventLoop.html">RoutingEventLoop</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple loop dectector for <a class="el" href="classKite_1_1RoutingEvent.html" title="Atomic Placement Request for a TrackSegment. ">RoutingEvent</a>. <a href="classKite_1_1RoutingEventLoop.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1RoutingEventQueue.html">RoutingEventQueue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The priority Queue of <a class="el" href="classKite_1_1RoutingEvent.html" title="Atomic Placement Request for a TrackSegment. ">RoutingEvent</a>. <a href="classKite_1_1RoutingEventQueue.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1RoutingPlane.html">RoutingPlane</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of Tracks in one Layer. <a href="classKite_1_1RoutingPlane.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1SegmentAction.html">SegmentAction</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store request for an event to be generated on a <a class="el" href="classKite_1_1TrackElement.html" title="Abstract Class for all Elements inserted inside a Track. ">TrackElement</a>. <a href="classKite_1_1SegmentAction.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1SegmentFsm.html">SegmentFsm</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pseudo-decorator to process a <a class="el" href="classKite_1_1RoutingEvent.html" title="Atomic Placement Request for a TrackSegment. ">RoutingEvent</a>. <a href="classKite_1_1SegmentFsm.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1SegmentObserver.html">SegmentObserver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Observer on the base AutoSegment. <a href="classKite_1_1SegmentObserver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1Session.html">Session</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceKite.html" title="The namespace dedicated to Kite. ">Kite</a> update <a class="el" href="classKite_1_1Session.html" title="Kite update Session. ">Session</a>. <a href="classKite_1_1Session.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1Track.html">Track</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure managing one routing track. <a href="classKite_1_1Track.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1TrackElement.html">TrackElement</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract Class for all Elements inserted inside a <a class="el" href="classKite_1_1Track.html" title="Structure managing one routing track. ">Track</a>. <a href="classKite_1_1TrackElement.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1TrackFixedSegment.html">TrackFixedSegment</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classKite_1_1Track.html" title="Structure managing one routing track. ">Track</a> elements for fixed wires. <a href="classKite_1_1TrackFixedSegment.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1TrackMarker.html">TrackMarker</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag part of <a class="el" href="classKite_1_1Track.html" title="Structure managing one routing track. ">Track</a> with a weight. <a href="classKite_1_1TrackMarker.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1TrackSegment.html">TrackSegment</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derived <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/katabatic/doc/html/katabatic.tag:../katabatic/" href="../katabatic/classKatabatic_1_1AutoSegment.html">Katabatic::AutoSegment</a> for the router. <a href="classKite_1_1TrackSegment.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKite_1_1VerticalTrack.html">VerticalTrack</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vertical track managment. <a href="classKite_1_1VerticalTrack.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ac86883c8d5a0f34ab9b4ec6eaaad6c9f"><td class="memItemLeft" align="right" valign="top">typedef void()&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKite.html#ac86883c8d5a0f34ab9b4ec6eaaad6c9f">SegmentOverlapCostCB</a>(const <a class="el" href="classKite_1_1TrackElement.html">TrackElement</a> *, TrackCost &amp;)</td></tr>
<tr class="separator:ac86883c8d5a0f34ab9b4ec6eaaad6c9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:acca8fffa3182dea5f94208f454f14b47"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47">FunctionFlags</a> { , <br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47abd49be7700e04e255b30a6cee68535fd">KtLoadGlobalRouting</a> = 0x00000001,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47a0441a09d569a7634f9d1826fa315ddcc">KtBuildGlobalRouting</a> = 0x00000002,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47a766f453d6caa06490196a952762f0bb8">KtAllowDoglegReuse</a> = 0x00000004,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47a68e917ff37d4b5cef906303181836404">KtDataSelf</a> = 0x00000008,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada">KtNearest</a> = 0x00000010,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47a5d7da665ec1368b29ee9d3e382cd1072">KtForce</a> = 0x00000020,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47aeb3b2254e460ac48ce9a57965ba3627b">KtResetCount</a> = 0x00000040,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47a8f9c41816abe8ac1da87d930bc12ed5e">KtWithPerpands</a> = 0x00000080,
<br />
&#160;&#160;<a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47abffa3499a9376f3e9f1de1ab6b8ba37b">KtWithConstraints</a> = 0x00000100
<br />
}</td></tr>
<tr class="separator:acca8fffa3182dea5f94208f454f14b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The namespace dedicated to <a class="el" href="namespaceKite.html" title="The namespace dedicated to Kite. ">Kite</a>. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="ac86883c8d5a0f34ab9b4ec6eaaad6c9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac86883c8d5a0f34ab9b4ec6eaaad6c9f">&#9670;&nbsp;</a></span>SegmentOverlapCostCB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SegmentOverlapCostCB</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype of overlap cost callback functions.</p>
<p><b>See also:</b>&#160; <a class="el" href="classKite_1_1TrackElement.html#a4648fa47d0870cf743436ff6a6239fd9">TrackSegment::setOverlapCostCB()</a>, TrackSegment::getOverlapCost(). </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="acca8fffa3182dea5f94208f454f14b47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acca8fffa3182dea5f94208f454f14b47">&#9670;&nbsp;</a></span>FunctionFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceKite.html#acca8fffa3182dea5f94208f454f14b47">FunctionFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47abd49be7700e04e255b30a6cee68535fd"></a>KtLoadGlobalRouting&#160;</td><td class="fielddoc"><p>Reload the global routing from a preciously saved run (<code></code>.kgr file). </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47a0441a09d569a7634f9d1826fa315ddcc"></a>KtBuildGlobalRouting&#160;</td><td class="fielddoc"><p>Run the global router Knik. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47a766f453d6caa06490196a952762f0bb8"></a>KtAllowDoglegReuse&#160;</td><td class="fielddoc"><p>Allow sharing of dogleg. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47a68e917ff37d4b5cef906303181836404"></a>KtDataSelf&#160;</td><td class="fielddoc"><p><span class="red">To be documented.</span> </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada"></a>KtNearest&#160;</td><td class="fielddoc"><p>Round the position to the nearest track axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47a5d7da665ec1368b29ee9d3e382cd1072"></a>KtForce&#160;</td><td class="fielddoc"><p>Force to perform an action ignoring the "up to date" state. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47aeb3b2254e460ac48ce9a57965ba3627b"></a>KtResetCount&#160;</td><td class="fielddoc"><p>Tells to reset a counter. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47a8f9c41816abe8ac1da87d930bc12ed5e"></a>KtWithPerpands&#160;</td><td class="fielddoc"><p>Ripup perpandiculars alongside the current segment. </p>
</td></tr>
<tr><td class="fieldname"><a id="acca8fffa3182dea5f94208f454f14b47abffa3499a9376f3e9f1de1ab6b8ba37b"></a>KtWithConstraints&#160;</td><td class="fielddoc"><p>Force constraints recomputation. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.14 on Mon Oct 28 2019</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>