<!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&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</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">RoutingEventQueue.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 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> <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@asim.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 : "./kite/RoutingEventQueue.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 KITE_ROUTING_EVENT_QUEUE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define KITE_ROUTING_EVENT_QUEUE_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="preprocessor">#include <set></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "kite/RoutingEvent.h"</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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceKite.html">Kite</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">using</span> std::set;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">using</span> std::multiset;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">using</span> std::vector;</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="comment">// -------------------------------------------------------------------</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Class : "RoutingEventQueue".</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classKite_1_1RoutingEventQueue.html"> 35</a></span>  <span class="keyword">class </span><a class="code" href="classKite_1_1RoutingEventQueue.html">RoutingEventQueue</a> {</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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classKite_1_1RoutingEventQueue.html#a67dd3abe4f9f4f32e91dfaa9573976ca">RoutingEventQueue</a> ();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classKite_1_1RoutingEventQueue.html#a28ed9894863ae1029f16744a86d4bfab">~RoutingEventQueue</a> ();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () <span class="keyword">const</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a259cb5a711406a8c3e5d937eb9350cca">size</a> () <span class="keyword">const</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a85befa55ce7e51c7067f4f7cb29acc0a">getTopEventLevel</a> () <span class="keyword">const</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classKite_1_1RoutingEvent.html">RoutingEvent</a>* <a class="code" href="classKite_1_1RoutingEventQueue.html#af1b85d0b49565932c55ec55625cd8838">pop</a> ();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a7f5a051812b2925dc3c1cca8b2011237">load</a> ( <span class="keyword">const</span> vector<TrackElement*>& );</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#af0813b67c9fc72d960f7e512e9403d57">add</a> ( <a class="code" href="classKite_1_1TrackElement.html">TrackElement</a>*, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> level );</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#ac802427673567526d06af911e94f7216">push</a> ( <a class="code" href="classKite_1_1RoutingEvent.html">RoutingEvent</a>* );</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#afd2fa6d6f5d90c472bea9befa97d955d">repush</a> ( <a class="code" href="classKite_1_1RoutingEvent.html">RoutingEvent</a>* );</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a4fb0022d3e8f91a862b5f6438b7f8dad">repushInvalidateds</a> ();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#ad55316f5135cdae6aa6c5a763f6c3473">commit</a> ();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> prepareRepair ();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> dump () <span class="keyword">const</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> _keyCheck () <span class="keyword">const</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  Record* _getRecord () <span class="keyword">const</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">string</span> _getString () <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">string</span> _getTypeName () <span class="keyword">const</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// Attributes.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _topEventLevel;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  RoutingEventSet _pushRequests;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  multiset<RoutingEvent*,RoutingEvent::Compare> _events;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classKite_1_1RoutingEventQueue.html">RoutingEventQueue</a>& operator= ( <span class="keyword">const</span> <a class="code" href="classKite_1_1RoutingEventQueue.html">RoutingEventQueue</a>& );</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classKite_1_1RoutingEventQueue.html#a67dd3abe4f9f4f32e91dfaa9573976ca">RoutingEventQueue</a> ( <span class="keyword">const</span> <a class="code" href="classKite_1_1RoutingEventQueue.html">RoutingEventQueue</a>& );</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</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> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// Inline Functions.</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classKite_1_1RoutingEventQueue.html#a644718bb2fb240de962dc3c9a1fdf0dc"> 72</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a644718bb2fb240de962dc3c9a1fdf0dc">RoutingEventQueue::empty</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _events.empty(); }</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classKite_1_1RoutingEventQueue.html#a259cb5a711406a8c3e5d937eb9350cca"> 73</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a259cb5a711406a8c3e5d937eb9350cca">RoutingEventQueue::size</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _events.size(); }</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classKite_1_1RoutingEventQueue.html#a85befa55ce7e51c7067f4f7cb29acc0a"> 74</a></span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#a85befa55ce7e51c7067f4f7cb29acc0a">RoutingEventQueue::getTopEventLevel</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _topEventLevel; }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">inline</span> <span class="keywordtype">string</span> RoutingEventQueue::_getTypeName ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"EventQueue"</span>; }</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classKite_1_1RoutingEventQueue.html#ac802427673567526d06af911e94f7216"> 76</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classKite_1_1RoutingEventQueue.html#ac802427673567526d06af911e94f7216">RoutingEventQueue::push</a> ( <a class="code" href="classKite_1_1RoutingEvent.html">RoutingEvent</a>* event ) { _pushRequests.insert( event ); }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// Kite namespace.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif // KITE_ROUTING_EVENT_QUEUE_H</span></div><div class="ttc" id="classKite_1_1RoutingEvent_html"><div class="ttname"><a href="classKite_1_1RoutingEvent.html">Kite::RoutingEvent</a></div><div class="ttdoc">Atomic Placement Request for a TrackSegment. </div><div class="ttdef"><b>Definition:</b> RoutingEvent.h:55</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a67dd3abe4f9f4f32e91dfaa9573976ca"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a67dd3abe4f9f4f32e91dfaa9573976ca">Kite::RoutingEventQueue::RoutingEventQueue</a></div><div class="ttdeci">RoutingEventQueue()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:47</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a644718bb2fb240de962dc3c9a1fdf0dc"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a644718bb2fb240de962dc3c9a1fdf0dc">Kite::RoutingEventQueue::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.h:72</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_af0813b67c9fc72d960f7e512e9403d57"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#af0813b67c9fc72d960f7e512e9403d57">Kite::RoutingEventQueue::add</a></div><div class="ttdeci">void add(TrackElement *, unsigned int level)</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:76</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_af1b85d0b49565932c55ec55625cd8838"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#af1b85d0b49565932c55ec55625cd8838">Kite::RoutingEventQueue::pop</a></div><div class="ttdeci">RoutingEvent * pop()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:120</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_ad55316f5135cdae6aa6c5a763f6c3473"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#ad55316f5135cdae6aa6c5a763f6c3473">Kite::RoutingEventQueue::commit</a></div><div class="ttdeci">void commit()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:90</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a85befa55ce7e51c7067f4f7cb29acc0a"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a85befa55ce7e51c7067f4f7cb29acc0a">Kite::RoutingEventQueue::getTopEventLevel</a></div><div class="ttdeci">unsigned int getTopEventLevel() const</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.h:74</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a28ed9894863ae1029f16744a86d4bfab"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a28ed9894863ae1029f16744a86d4bfab">Kite::RoutingEventQueue::~RoutingEventQueue</a></div><div class="ttdeci">~RoutingEventQueue()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:54</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a4fb0022d3e8f91a862b5f6438b7f8dad"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a4fb0022d3e8f91a862b5f6438b7f8dad">Kite::RoutingEventQueue::repushInvalidateds</a></div><div class="ttdeci">void repushInvalidateds()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:171</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_ac802427673567526d06af911e94f7216"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#ac802427673567526d06af911e94f7216">Kite::RoutingEventQueue::push</a></div><div class="ttdeci">void push(RoutingEvent *)</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.h:76</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_a259cb5a711406a8c3e5d937eb9350cca"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a259cb5a711406a8c3e5d937eb9350cca">Kite::RoutingEventQueue::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.h:73</div></div>
<div class="ttc" id="classKite_1_1TrackElement_html"><div class="ttname"><a href="classKite_1_1TrackElement.html">Kite::TrackElement</a></div><div class="ttdoc">Abstract Class for all Elements inserted inside a Track. </div><div class="ttdef"><b>Definition:</b> TrackElement.h:100</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html">Kite::RoutingEventQueue</a></div><div class="ttdoc">The priority Queue of RoutingEvent. </div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.h:35</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_ac8bb3912a3ce86b15842e79d0b421204"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#ac8bb3912a3ce86b15842e79d0b421204">Kite::RoutingEventQueue::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:203</div></div>
<div class="ttc" id="classKite_1_1RoutingEventQueue_html_afd2fa6d6f5d90c472bea9befa97d955d"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#afd2fa6d6f5d90c472bea9befa97d955d">Kite::RoutingEventQueue::repush</a></div><div class="ttdeci">void repush(RoutingEvent *)</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:149</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_1RoutingEventQueue_html_a7f5a051812b2925dc3c1cca8b2011237"><div class="ttname"><a href="classKite_1_1RoutingEventQueue.html#a7f5a051812b2925dc3c1cca8b2011237">Kite::RoutingEventQueue::load</a></div><div class="ttdeci">void load(const vector< TrackElement *> &)</div><div class="ttdef"><b>Definition:</b> RoutingEventQueue.cpp:58</div></div>
</div><!-- fragment --></div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.14 on Thu Nov 12 2020</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 © 2008-2020 Sorbonne Universite. All rights reserved</small></td>
</tr>
</table>
</body>
</html>