135 lines
10 KiB
TeX
135 lines
10 KiB
TeX
\hypertarget{classKite_1_1KiteEngine}{}\subsection{Kite\+Engine Class Reference}
|
|
\label{classKite_1_1KiteEngine}\index{Kite\+Engine@{Kite\+Engine}}
|
|
|
|
|
|
The \mbox{\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
|
|
\textbf{ Katabatic\+Engine} $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}{base}} ()
|
|
\item
|
|
Configuration $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_a1af1f95e771fba5c85a19ea2d686553a}{get\+Kite\+Configuration}} ()
|
|
\item
|
|
virtual Configuration $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}{get\+Configuration}} ()
|
|
\item
|
|
\textbf{ Net} $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_aef6f41b0e8265ad574d1797f46ab9fa8}{get\+Blockage\+Net}} ()
|
|
\item
|
|
bool \mbox{\hyperlink{classKite_1_1KiteEngine_ae88a4ccf0189655c785df38e5d75155c}{get\+Tool\+Success}} () const
|
|
\item
|
|
unsigned long \mbox{\hyperlink{classKite_1_1KiteEngine_abb19e465ef249651bfc0efbe6f23ef1d}{get\+Events\+Limit}} () const
|
|
\item
|
|
unsigned int \mbox{\hyperlink{classKite_1_1KiteEngine_aa9cc4f640a8b50dc1bcff8d938a09c3c}{get\+Ripup\+Limit}} (unsigned int type) const
|
|
\item
|
|
unsigned int \mbox{\hyperlink{classKite_1_1KiteEngine_a1b4de41d8359251bcfbda288ec6bbbee}{get\+Ripup\+Cost}} () const
|
|
\end{DoxyCompactItemize}
|
|
\subsubsection*{Static Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
static const \textbf{ Name} \& \mbox{\hyperlink{classKite_1_1KiteEngine_a802eee6265da8d536db52d412f8a4afd}{static\+Get\+Name}} ()
|
|
\item
|
|
static \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}{create}} (\textbf{ Cell} $\ast$)
|
|
\item
|
|
static \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} $\ast$ \mbox{\hyperlink{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}{get}} (const \textbf{ Cell} $\ast$)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsubsection{Detailed Description}
|
|
The \mbox{\hyperlink{namespaceKite}{Kite}} Tool.
|
|
|
|
{\bfseries Lookup Mechanism}
|
|
|
|
Please look at \mbox{\hyperlink{classKite_1_1Session}{Kite\+::\+Session}} for an explanation of the lookup mechanism from \textbf{ Hurricane\+::\+Segment} or \textbf{ Katabatic\+::\+Auto\+Segment} to \mbox{\hyperlink{classKite_1_1TrackSegment}{Track\+Segment}}.
|
|
|
|
\subsubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classKite_1_1KiteEngine_a802eee6265da8d536db52d412f8a4afd}\label{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\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{static\+Get\+Name()}{staticGetName()}}
|
|
{\footnotesize\ttfamily const \textbf{ Name} \& static\+Get\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
|
|
|
{\bfseries Returns\+:} The unique string identifier for the \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} class of Tool\+Engine. \mbox{\Hypertarget{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}\label{classKite_1_1KiteEngine_a520d92a22c1becdc0fbbec927365db21}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!create@{create}}
|
|
\index{create@{create}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{create()}{create()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} $\ast$ create (\begin{DoxyParamCaption}\item[{\textbf{ Cell} $\ast$}]{cell }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
|
|
|
Create a \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} on {\ttfamily cell}. \mbox{\Hypertarget{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}\label{classKite_1_1KiteEngine_a9905ab1f7a970bc947adb8ddf54e55e1}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get@{get}}
|
|
\index{get@{get}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get()}{get()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} $\ast$ get (\begin{DoxyParamCaption}\item[{const \textbf{ Cell} $\ast$}]{cell }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
|
|
|
{\bfseries Returns\+:} The \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} associated to {\ttfamily cell}. {\ttfamily N\+U\+LL} if there isn\textquotesingle{}t. \mbox{\Hypertarget{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}\label{classKite_1_1KiteEngine_a2313df62af32702cf749c15d349af5ea}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!base@{base}}
|
|
\index{base@{base}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{base()}{base()}}
|
|
{\footnotesize\ttfamily \textbf{ Katabatic\+Engine} $\ast$ base (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\bfseries Returns\+:} The \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}}, casted as it\textquotesingle{}s base class (Katabatic\+Engine). \mbox{\Hypertarget{classKite_1_1KiteEngine_a1af1f95e771fba5c85a19ea2d686553a}\label{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\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Kite\+Configuration()}{getKiteConfiguration()}}
|
|
{\footnotesize\ttfamily Configuration $\ast$ get\+Kite\+Configuration (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\bfseries Returns\+:} The \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} configuration. The \mbox{\hyperlink{namespaceKite}{Kite}} Configuration is a derived class of Katabatic\+Configuration. \mbox{\Hypertarget{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}\label{classKite_1_1KiteEngine_a9a7fbadfe526875680f698c76adfb128}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get\+Configuration@{get\+Configuration}}
|
|
\index{get\+Configuration@{get\+Configuration}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Configuration()}{getConfiguration()}}
|
|
{\footnotesize\ttfamily Configuration $\ast$ get\+Configuration (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The \mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} configuration.
|
|
|
|
Reimplemented from \textbf{ Katabatic\+Engine}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1KiteEngine_aef6f41b0e8265ad574d1797f46ab9fa8}\label{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\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Blockage\+Net()}{getBlockageNet()}}
|
|
{\footnotesize\ttfamily \textbf{ Net} $\ast$ get\+Blockage\+Net (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\bfseries Returns\+:} The Net which is used to mark the blockage segments. It\textquotesingle{}s not part of the Configuration {\itshape per se} but an isolated attribute. \mbox{\Hypertarget{classKite_1_1KiteEngine_ae88a4ccf0189655c785df38e5d75155c}\label{classKite_1_1KiteEngine_ae88a4ccf0189655c785df38e5d75155c}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get\+Tool\+Success@{get\+Tool\+Success}}
|
|
\index{get\+Tool\+Success@{get\+Tool\+Success}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Tool\+Success()}{getToolSuccess()}}
|
|
{\footnotesize\ttfamily bool get\+Tool\+Success (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\bfseries Returns\+:} {\bfseries true} if the tool was successful, that is, all the Net were routeds. \mbox{\Hypertarget{classKite_1_1KiteEngine_abb19e465ef249651bfc0efbe6f23ef1d}\label{classKite_1_1KiteEngine_abb19e465ef249651bfc0efbe6f23ef1d}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get\+Events\+Limit@{get\+Events\+Limit}}
|
|
\index{get\+Events\+Limit@{get\+Events\+Limit}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Events\+Limit()}{getEventsLimit()}}
|
|
{\footnotesize\ttfamily unsigned long get\+Events\+Limit (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\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. \mbox{\Hypertarget{classKite_1_1KiteEngine_aa9cc4f640a8b50dc1bcff8d938a09c3c}\label{classKite_1_1KiteEngine_aa9cc4f640a8b50dc1bcff8d938a09c3c}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get\+Ripup\+Limit@{get\+Ripup\+Limit}}
|
|
\index{get\+Ripup\+Limit@{get\+Ripup\+Limit}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Ripup\+Limit()}{getRipupLimit()}}
|
|
{\footnotesize\ttfamily unsigned long get\+Ripup\+Limit (\begin{DoxyParamCaption}\item[{unsigned int}]{type }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\bfseries Returns\+:} the maximum ripup allowed of a segment of {\ttfamily type}.
|
|
|
|
Referenced by Manipulator\+::can\+Ripup(), and Segment\+Action\+::do\+Action().
|
|
|
|
\mbox{\Hypertarget{classKite_1_1KiteEngine_a1b4de41d8359251bcfbda288ec6bbbee}\label{classKite_1_1KiteEngine_a1b4de41d8359251bcfbda288ec6bbbee}}
|
|
\index{Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}!get\+Ripup\+Cost@{get\+Ripup\+Cost}}
|
|
\index{get\+Ripup\+Cost@{get\+Ripup\+Cost}!Kite\+::\+Kite\+Engine@{Kite\+::\+Kite\+Engine}}
|
|
\paragraph{\texorpdfstring{get\+Ripup\+Cost()}{getRipupCost()}}
|
|
{\footnotesize\ttfamily unsigned long get\+Ripup\+Cost (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
{\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}
|