\hypertarget{classKite_1_1KiteEngine}{\subsection{Kite\-Engine Class Reference}
\label{classKite_1_1KiteEngine}\index{Kite\-Engine@{Kite\-Engine}}
}


The \hyperlink{namespaceKite}{Kite} Tool.  




Inheritance diagram for Kite\-Engine\-:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=168pt]{classKite_1_1KiteEngine__inherit__graph}
\end{center}
\end{figure}
\subsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Katabatic\-Engine} $\ast$ \hyperlink{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}{base} ()
\item 
Configuration $\ast$ \hyperlink{classKite_1_1KiteEngine_a1af1f95e771fba5c85a19ea2d686553a}{get\-Kite\-Configuration} ()
\item 
virtual Configuration $\ast$ \hyperlink{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}{get\-Configuration} ()
\item 
{\bf Net} $\ast$ \hyperlink{classKite_1_1KiteEngine_aef6f41b0e8265ad574d1797f46ab9fa8}{get\-Blockage\-Net} ()
\item 
bool \hyperlink{classKite_1_1KiteEngine_a41bc96a41054daf75c95534f5e9074f2}{get\-Tool\-Success} () const 
\item 
unsigned long \hyperlink{classKite_1_1KiteEngine_ae48c062468dc5dcfdaceefe5793042db}{get\-Events\-Limit} () const 
\item 
unsigned int \hyperlink{classKite_1_1KiteEngine_a7f8e279242f9b3290c704d472748f352}{get\-Ripup\-Limit} (unsigned int type) const 
\item 
unsigned int \hyperlink{classKite_1_1KiteEngine_a2fe3f5ebd3f8176172f5890a612b0174}{get\-Ripup\-Cost} () const 
\end{DoxyCompactItemize}
\subsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static const {\bf Name} \& \hyperlink{classKite_1_1KiteEngine_a802eee6265da8d536db52d412f8a4afd}{static\-Get\-Name} ()
\item 
static \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} $\ast$ \hyperlink{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}{create} ({\bf Cell} $\ast$)
\item 
static \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} $\ast$ \hyperlink{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}{get} (const {\bf Cell} $\ast$)
\end{DoxyCompactItemize}


\subsubsection{Detailed Description}
The \hyperlink{namespaceKite}{Kite} Tool. 

{\bfseries Lookup Mechanism}

Please look at \hyperlink{classKite_1_1Session}{Kite\-::\-Session} for an explanation of the lookup mechanism from {\bf Hurricane\-::\-Segment} or {\bf Katabatic\-::\-Auto\-Segment} to \hyperlink{classKite_1_1TrackSegment}{Track\-Segment}. 

\subsubsection{Member Function Documentation}
\hypertarget{classKite_1_1KiteEngine_a802eee6265da8d536db52d412f8a4afd}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!static\-Get\-Name@{static\-Get\-Name}}
\index{static\-Get\-Name@{static\-Get\-Name}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{static\-Get\-Name}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf Name} \& static\-Get\-Name (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classKite_1_1KiteEngine_a802eee6265da8d536db52d412f8a4afd}
{\bfseries Returns\-:} The unique string identifier for the \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} class of Tool\-Engine. \hypertarget{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!create@{create}}
\index{create@{create}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{create}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Kite\-Engine} $\ast$ create (
\begin{DoxyParamCaption}
\item[{{\bf Cell} $\ast$}]{cell}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}
Create a \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} on {\ttfamily cell}. \hypertarget{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get@{get}}
\index{get@{get}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Kite\-Engine} $\ast$ get (
\begin{DoxyParamCaption}
\item[{const {\bf Cell} $\ast$}]{cell}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}
{\bfseries Returns\-:} The \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} associated to {\ttfamily cell}. {\ttfamily N\-U\-L\-L} if there isn't. \hypertarget{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!base@{base}}
\index{base@{base}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{base}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Katabatic\-Engine} $\ast$ base (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}
{\bfseries Returns\-:} The \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine}, casted as it's base class (Katabatic\-Engine). \hypertarget{classKite_1_1KiteEngine_a1af1f95e771fba5c85a19ea2d686553a}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Kite\-Configuration@{get\-Kite\-Configuration}}
\index{get\-Kite\-Configuration@{get\-Kite\-Configuration}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Kite\-Configuration}]{\setlength{\rightskip}{0pt plus 5cm}Configuration $\ast$ get\-Kite\-Configuration (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_a1af1f95e771fba5c85a19ea2d686553a}
{\bfseries Returns\-:} The \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} configuration. The \hyperlink{namespaceKite}{Kite} Configuration is a derived class of Katabatic\-Configuration. \hypertarget{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Configuration@{get\-Configuration}}
\index{get\-Configuration@{get\-Configuration}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Configuration}]{\setlength{\rightskip}{0pt plus 5cm}Configuration $\ast$ get\-Configuration (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}
{\bfseries Returns\-:} The \hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} configuration. 

Reimplemented from {\bf Katabatic\-Engine}.

\hypertarget{classKite_1_1KiteEngine_aef6f41b0e8265ad574d1797f46ab9fa8}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Blockage\-Net@{get\-Blockage\-Net}}
\index{get\-Blockage\-Net@{get\-Blockage\-Net}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Blockage\-Net}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Net} $\ast$ get\-Blockage\-Net (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_aef6f41b0e8265ad574d1797f46ab9fa8}
{\bfseries Returns\-:} The Net which is used to mark the blockage segments. It's not part of the Configuration {\itshape per se} but an isolated attribute. \hypertarget{classKite_1_1KiteEngine_a41bc96a41054daf75c95534f5e9074f2}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Tool\-Success@{get\-Tool\-Success}}
\index{get\-Tool\-Success@{get\-Tool\-Success}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Tool\-Success}]{\setlength{\rightskip}{0pt plus 5cm}bool get\-Tool\-Success (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_a41bc96a41054daf75c95534f5e9074f2}
{\bfseries Returns\-:} {\bfseries true} if the tool was successful, that is, all the Net were routeds. \hypertarget{classKite_1_1KiteEngine_ae48c062468dc5dcfdaceefe5793042db}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Events\-Limit@{get\-Events\-Limit}}
\index{get\-Events\-Limit@{get\-Events\-Limit}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Events\-Limit}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long get\-Events\-Limit (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_ae48c062468dc5dcfdaceefe5793042db}
{\bfseries Returns\-:} The maximal number of allowed routing events. This limit is a security against infinite looping, be sure that it is great enough not to prevent normal routing completion. \hypertarget{classKite_1_1KiteEngine_a7f8e279242f9b3290c704d472748f352}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Ripup\-Limit@{get\-Ripup\-Limit}}
\index{get\-Ripup\-Limit@{get\-Ripup\-Limit}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Ripup\-Limit}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long get\-Ripup\-Limit (
\begin{DoxyParamCaption}
\item[{unsigned int}]{type}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_a7f8e279242f9b3290c704d472748f352}
{\bfseries Returns\-:} the maximum ripup allowed of a segment of {\ttfamily type}. 

Referenced by Manipulator\-::can\-Ripup(), and Segment\-Action\-::do\-Action().

\hypertarget{classKite_1_1KiteEngine_a2fe3f5ebd3f8176172f5890a612b0174}{\index{Kite\-::\-Kite\-Engine@{Kite\-::\-Kite\-Engine}!get\-Ripup\-Cost@{get\-Ripup\-Cost}}
\index{get\-Ripup\-Cost@{get\-Ripup\-Cost}!Kite::KiteEngine@{Kite\-::\-Kite\-Engine}}
\paragraph[{get\-Ripup\-Cost}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long get\-Ripup\-Cost (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1KiteEngine_a2fe3f5ebd3f8176172f5890a612b0174}
{\bfseries Returns\-:} the differential used while comparing two ripup costs. 

The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
Kite\-Engine.\-h\item 
Kite\-Engine.\-dox\end{DoxyCompactItemize}