coriolis/kite/doc/latex/namespaceKite.tex

120 lines
10 KiB
TeX

\hypertarget{namespaceKite}{\subsection{Kite Namespace Reference}
\label{namespaceKite}\index{Kite@{Kite}}
}
The namespace dedicated to \hyperlink{namespaceKite}{Kite}.
\subsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
class \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine}
\begin{DoxyCompactList}\small\item\em The \hyperlink{namespaceKite}{Kite} Tool. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1DataNegociate}{Data\-Negociate}
\begin{DoxyCompactList}\small\item\em Algorimthmic datas associated the \hyperlink{classKite_1_1TrackSegment}{Track\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1TrackMarker}{Track\-Marker}
\begin{DoxyCompactList}\small\item\em Tag part of \hyperlink{classKite_1_1Track}{Track} with a weight. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1SegmentObserver}{Segment\-Observer}
\begin{DoxyCompactList}\small\item\em Observer on the base Auto\-Segment. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1TrackElement}{Track\-Element}
\begin{DoxyCompactList}\small\item\em Abstract Class for all Elements inserted inside a \hyperlink{classKite_1_1Track}{Track}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1TrackSegment}{Track\-Segment}
\begin{DoxyCompactList}\small\item\em Derived {\bf Katabatic\-::\-Auto\-Segment} for the router. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1TrackFixedSegment}{Track\-Fixed\-Segment}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKite_1_1Track}{Track} elements for fixed wires. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1Track}{Track}
\begin{DoxyCompactList}\small\item\em Structure managing one routing track. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1HorizontalTrack}{Horizontal\-Track}
\begin{DoxyCompactList}\small\item\em Horizontal track managment. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1VerticalTrack}{Vertical\-Track}
\begin{DoxyCompactList}\small\item\em Vertical track managment. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1RoutingPlane}{Routing\-Plane}
\begin{DoxyCompactList}\small\item\em Array of Tracks in one Layer. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1Manipulator}{Manipulator}
\begin{DoxyCompactList}\small\item\em Handle \hyperlink{classKite_1_1TrackElement}{Track\-Element} ripup \& topological modifications. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1SegmentAction}{Segment\-Action}
\begin{DoxyCompactList}\small\item\em Store request for an event to be generated on a \hyperlink{classKite_1_1TrackElement}{Track\-Element}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm}
\begin{DoxyCompactList}\small\item\em Pseudo-\/decorator to process a \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}
\begin{DoxyCompactList}\small\item\em Atomic Placement Request for a \hyperlink{classKite_1_1TrackSegment}{Track\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1RoutingEventQueue}{Routing\-Event\-Queue}
\begin{DoxyCompactList}\small\item\em The priority Queue of \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1RoutingEventLoop}{Routing\-Event\-Loop}
\begin{DoxyCompactList}\small\item\em Simple loop dectector for \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1RoutingEventHistory}{Routing\-Event\-History}
\begin{DoxyCompactList}\small\item\em History of \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1NegociateWindow}{Negociate\-Window}
\begin{DoxyCompactList}\small\item\em Perform the routing, main \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} manager. \end{DoxyCompactList}\item
class \hyperlink{classKite_1_1Session}{Session}
\begin{DoxyCompactList}\small\item\em \hyperlink{namespaceKite}{Kite} update \hyperlink{classKite_1_1Session}{Session}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
typedef void( \hyperlink{namespaceKite_aa5bc3df660243357cdf8639f57d4a41b}{Segment\-Overlap\-Cost\-C\-B} )(const \hyperlink{classKite_1_1TrackElement}{Track\-Element} $\ast$, Track\-Cost \&)
\end{DoxyCompactItemize}
\subsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum \hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47}{Function\-Flags} \{ , \\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47abd49be7700e04e255b30a6cee68535fd}{Kt\-Load\-Global\-Routing} = 0x00000001,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47a0441a09d569a7634f9d1826fa315ddcc}{Kt\-Build\-Global\-Routing} = 0x00000002,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47a766f453d6caa06490196a952762f0bb8}{Kt\-Allow\-Dogleg\-Reuse} = 0x00000004,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47a68e917ff37d4b5cef906303181836404}{Kt\-Data\-Self} = 0x00000008,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada}{Kt\-Nearest} = 0x00000010,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47a5d7da665ec1368b29ee9d3e382cd1072}{Kt\-Force} = 0x00000020,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47aeb3b2254e460ac48ce9a57965ba3627b}{Kt\-Reset\-Count} = 0x00000040,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47a8f9c41816abe8ac1da87d930bc12ed5e}{Kt\-With\-Perpands} = 0x00000080,
\\*
\hyperlink{namespaceKite_acca8fffa3182dea5f94208f454f14b47abffa3499a9376f3e9f1de1ab6b8ba37b}{Kt\-With\-Constraints} = 0x00000100
\}
\end{DoxyCompactItemize}
\subsubsection{Detailed Description}
The namespace dedicated to \hyperlink{namespaceKite}{Kite}.
\subsubsection{Typedef Documentation}
\hypertarget{namespaceKite_aa5bc3df660243357cdf8639f57d4a41b}{\index{Kite@{Kite}!Segment\-Overlap\-Cost\-C\-B@{Segment\-Overlap\-Cost\-C\-B}}
\index{Segment\-Overlap\-Cost\-C\-B@{Segment\-Overlap\-Cost\-C\-B}!Kite@{Kite}}
\paragraph[{Segment\-Overlap\-Cost\-C\-B}]{\setlength{\rightskip}{0pt plus 5cm}Segment\-Overlap\-Cost\-C\-B}}\label{namespaceKite_aa5bc3df660243357cdf8639f57d4a41b}
Prototype of overlap cost callback functions.
{\bfseries See also\-:}~ \hyperlink{classKite_1_1TrackElement_a4648fa47d0870cf743436ff6a6239fd9}{Track\-Segment\-::set\-Overlap\-Cost\-C\-B()}, Track\-Segment\-::get\-Overlap\-Cost().
\subsubsection{Enumeration Type Documentation}
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47}{\index{Kite@{Kite}!Function\-Flags@{Function\-Flags}}
\index{Function\-Flags@{Function\-Flags}!Kite@{Kite}}
\paragraph[{Function\-Flags}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Function\-Flags}}}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47}
\begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Kt\-Load\-Global\-Routing@{Kt\-Load\-Global\-Routing}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Load\-Global\-Routing@{Kt\-Load\-Global\-Routing}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47abd49be7700e04e255b30a6cee68535fd}{Kt\-Load\-Global\-Routing}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47abd49be7700e04e255b30a6cee68535fd}
}]Reload the global routing from a preciously saved run ({\ttfamily }.kgr file). \index{Kt\-Build\-Global\-Routing@{Kt\-Build\-Global\-Routing}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Build\-Global\-Routing@{Kt\-Build\-Global\-Routing}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47a0441a09d569a7634f9d1826fa315ddcc}{Kt\-Build\-Global\-Routing}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47a0441a09d569a7634f9d1826fa315ddcc}
}]Run the global router Knik. \index{Kt\-Allow\-Dogleg\-Reuse@{Kt\-Allow\-Dogleg\-Reuse}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Allow\-Dogleg\-Reuse@{Kt\-Allow\-Dogleg\-Reuse}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47a766f453d6caa06490196a952762f0bb8}{Kt\-Allow\-Dogleg\-Reuse}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47a766f453d6caa06490196a952762f0bb8}
}]Allow sharing of dogleg. \index{Kt\-Data\-Self@{Kt\-Data\-Self}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Data\-Self@{Kt\-Data\-Self}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47a68e917ff37d4b5cef906303181836404}{Kt\-Data\-Self}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47a68e917ff37d4b5cef906303181836404}
}]To be documented. \index{Kt\-Nearest@{Kt\-Nearest}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Nearest@{Kt\-Nearest}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada}{Kt\-Nearest}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47afaf04b2ddbae58557683c20373c0bada}
}]Round the position to the nearest track axis. \index{Kt\-Force@{Kt\-Force}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Force@{Kt\-Force}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47a5d7da665ec1368b29ee9d3e382cd1072}{Kt\-Force}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47a5d7da665ec1368b29ee9d3e382cd1072}
}]Force to perform an action ignoring the \char`\"{}up to date\char`\"{} state. \index{Kt\-Reset\-Count@{Kt\-Reset\-Count}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-Reset\-Count@{Kt\-Reset\-Count}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47aeb3b2254e460ac48ce9a57965ba3627b}{Kt\-Reset\-Count}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47aeb3b2254e460ac48ce9a57965ba3627b}
}]Tells to reset a counter. \index{Kt\-With\-Perpands@{Kt\-With\-Perpands}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-With\-Perpands@{Kt\-With\-Perpands}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47a8f9c41816abe8ac1da87d930bc12ed5e}{Kt\-With\-Perpands}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47a8f9c41816abe8ac1da87d930bc12ed5e}
}]Ripup perpandiculars alongside the current segment. \index{Kt\-With\-Constraints@{Kt\-With\-Constraints}!Kite@{Kite}}\index{Kite@{Kite}!Kt\-With\-Constraints@{Kt\-With\-Constraints}}\item[{\em
\hypertarget{namespaceKite_acca8fffa3182dea5f94208f454f14b47abffa3499a9376f3e9f1de1ab6b8ba37b}{Kt\-With\-Constraints}\label{namespaceKite_acca8fffa3182dea5f94208f454f14b47abffa3499a9376f3e9f1de1ab6b8ba37b}
}]Force constraints recomputation. \end{description}
\end{Desc}