\hypertarget{classKatabatic_1_1Grid}{\section{Grid$<$ G\-Cell\-T $>$ Class Template Reference}
\label{classKatabatic_1_1Grid}\index{Grid$<$ G\-Cell\-T $>$@{Grid$<$ G\-Cell\-T $>$}}
}


Template Class for Regular \hyperlink{classKatabatic_1_1Grid}{Grid}.  




Inheritance diagram for Grid$<$ G\-Cell\-T $>$\-:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=162pt]{classKatabatic_1_1Grid__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_ae9a2132d74bd6a15002a3917f57516ae}{get\-G\-Cell} (unsigned int index) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a40a8afc66df78d74cb080eacfe1322e2}{get\-G\-Cell} (const {\bf Point} p) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a1295cff651e7319a380bde52deddd360}{get\-G\-Cell} (const {\bf Point} p1, const {\bf Point} p2) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a2ae58a243a3f62f0f28e4e2b4b2bb308}{get\-G\-Cell\-Left} (const G\-Cell\-T $\ast$gcell) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a71483ce8b6a02771e89b410711179740}{get\-G\-Cell\-Right} (const G\-Cell\-T $\ast$gcell) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a6af56d56284dd6fde6e3a6c781cb4faf}{get\-G\-Cell\-Up} (const G\-Cell\-T $\ast$gcell) const 
\item 
G\-Cell\-T $\ast$ \hyperlink{classKatabatic_1_1Grid_a594f0986971454bc9655d9943126ae8c}{get\-G\-Cell\-Down} (const G\-Cell\-T $\ast$gcell) const 
\item 
{\bf Generic\-Collection}$<$ G\-Cell\-T $\ast$ $>$ \hyperlink{classKatabatic_1_1Grid_a24b4ab5b46b56ee744cf4c368a114d95}{get\-G\-Cells} ()
\item 
{\bf Generic\-Collection}$<$ G\-Cell\-T $\ast$ $>$ \hyperlink{classKatabatic_1_1Grid_aa8d0393323104d48c089a8429b254689}{get\-G\-Cells\-Column} (unsigned int column, unsigned int row\-Start, unsigned int row\-Stop)
\item 
{\bf Generic\-Collection}$<$ G\-Cell\-T $\ast$ $>$ \hyperlink{classKatabatic_1_1Grid_a35e2075302cdb696945f05c5bcc817a0}{get\-G\-Cells\-Row} (unsigned int row, unsigned int column\-Start, unsigned int column\-Stop)
\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classKatabatic_1_1Grid_a1b772cc784f7110caca47acb76dcec62}{Grid} (const {\bf Box} \&)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename G\-Cell\-T$>$class Katabatic\-::\-Grid$<$ G\-Cell\-T $>$}

Template Class for Regular \hyperlink{classKatabatic_1_1Grid}{Grid}. 

Contains all general purpose methods depending on the \hyperlink{classKatabatic_1_1GCell}{G\-Cell} type and geometrical computations. The internal storage is still not implemented in this class. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classKatabatic_1_1Grid_a1b772cc784f7110caca47acb76dcec62}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!Grid@{Grid}}
\index{Grid@{Grid}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{Grid}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Grid} (
\begin{DoxyParamCaption}
\item[{const {\bf Box} \&}]{bb}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classKatabatic_1_1Grid_a1b772cc784f7110caca47acb76dcec62}
\hyperlink{classKatabatic_1_1Grid}{Grid} constructor. 

\subsection{Member Function Documentation}
\hypertarget{classKatabatic_1_1Grid_ae9a2132d74bd6a15002a3917f57516ae}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell@{get\-G\-Cell}}
\index{get\-G\-Cell@{get\-G\-Cell}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell (
\begin{DoxyParamCaption}
\item[{unsigned int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_ae9a2132d74bd6a15002a3917f57516ae}
{\bfseries Returns\-:} The grid object at linear index {\ttfamily index} in the vector. If {\ttfamily index} is out of bounds, return {\ttfamily N\-U\-L\-L}. 

Referenced by G\-Cell\-Topology\-::do\-Rp\-\_\-\-Access\-Pad(), G\-Cell\-Topology\-::do\-Rp\-\_\-\-Auto\-Contacts(), and anonymous\-\_\-namespace\{\-Load\-Gr\-By\-Net.\-cpp\}\-::single\-G\-Cell().

\hypertarget{classKatabatic_1_1Grid_a40a8afc66df78d74cb080eacfe1322e2}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell@{get\-G\-Cell}}
\index{get\-G\-Cell@{get\-G\-Cell}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell (
\begin{DoxyParamCaption}
\item[{const {\bf Point}}]{p}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a40a8afc66df78d74cb080eacfe1322e2}
{\bfseries Returns\-:} The grid object which is under position {\ttfamily p}. \hypertarget{classKatabatic_1_1Grid_a1295cff651e7319a380bde52deddd360}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell@{get\-G\-Cell}}
\index{get\-G\-Cell@{get\-G\-Cell}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell (
\begin{DoxyParamCaption}
\item[{const {\bf Point}}]{p1, }
\item[{const {\bf Point}}]{p2}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a1295cff651e7319a380bde52deddd360}
{\bfseries Returns\-:} The grid object which is under position {\ttfamily p1} and {\ttfamily p2}. Not very clear though. \hypertarget{classKatabatic_1_1Grid_a2ae58a243a3f62f0f28e4e2b4b2bb308}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell\-Left@{get\-G\-Cell\-Left}}
\index{get\-G\-Cell\-Left@{get\-G\-Cell\-Left}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell\-Left}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell\-Left (
\begin{DoxyParamCaption}
\item[{const G\-Cell\-T $\ast$}]{gcell}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a2ae58a243a3f62f0f28e4e2b4b2bb308}
{\bfseries Returns\-:} The left neighbor of {\ttfamily gcell}, {\ttfamily N\-U\-L\-L} if it is the leftmost one. 

Referenced by G\-Cell\-::get\-Left().

\hypertarget{classKatabatic_1_1Grid_a71483ce8b6a02771e89b410711179740}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell\-Right@{get\-G\-Cell\-Right}}
\index{get\-G\-Cell\-Right@{get\-G\-Cell\-Right}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell\-Right}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell\-Right (
\begin{DoxyParamCaption}
\item[{const G\-Cell\-T $\ast$}]{gcell}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a71483ce8b6a02771e89b410711179740}
{\bfseries Returns\-:} The rigth neighbor of {\ttfamily gcell}, {\ttfamily N\-U\-L\-L} if it is the rightmost one. 

Referenced by G\-Cell\-::get\-Right().

\hypertarget{classKatabatic_1_1Grid_a6af56d56284dd6fde6e3a6c781cb4faf}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell\-Up@{get\-G\-Cell\-Up}}
\index{get\-G\-Cell\-Up@{get\-G\-Cell\-Up}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell\-Up}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell\-Up (
\begin{DoxyParamCaption}
\item[{const G\-Cell\-T $\ast$}]{gcell}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a6af56d56284dd6fde6e3a6c781cb4faf}
{\bfseries Returns\-:} The upper neighbor of {\ttfamily gcell}, {\ttfamily N\-U\-L\-L} if it is the uppermost one. 

Referenced by G\-Cell\-::get\-Up().

\hypertarget{classKatabatic_1_1Grid_a594f0986971454bc9655d9943126ae8c}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cell\-Down@{get\-G\-Cell\-Down}}
\index{get\-G\-Cell\-Down@{get\-G\-Cell\-Down}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cell\-Down}]{\setlength{\rightskip}{0pt plus 5cm}C\-Gell\-T $\ast$ get\-G\-Cell\-Down (
\begin{DoxyParamCaption}
\item[{const G\-Cell\-T $\ast$}]{gcell}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a594f0986971454bc9655d9943126ae8c}
{\bfseries Returns\-:} The down neighbor of {\ttfamily gcell}, {\ttfamily N\-U\-L\-L} if it is the downmost one. 

Referenced by G\-Cell\-::get\-Down().

\hypertarget{classKatabatic_1_1Grid_a24b4ab5b46b56ee744cf4c368a114d95}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cells@{get\-G\-Cells}}
\index{get\-G\-Cells@{get\-G\-Cells}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cells}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Generic\-Collection}$<$ C\-Gell\-T $\ast$ $>$ get\-G\-Cells (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a24b4ab5b46b56ee744cf4c368a114d95}
{\bfseries Returns\-:} A G\-Cell\-T {\bf Hurricane} collection built upon the linear G\-Cell\-T vector of the grid. \hypertarget{classKatabatic_1_1Grid_aa8d0393323104d48c089a8429b254689}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cells\-Column@{get\-G\-Cells\-Column}}
\index{get\-G\-Cells\-Column@{get\-G\-Cells\-Column}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cells\-Column}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Generic\-Collection}$<$ C\-Gell\-T $\ast$ $>$ get\-G\-Cells\-Column (
\begin{DoxyParamCaption}
\item[{unsigned int}]{column, }
\item[{unsigned int}]{row\-Start, }
\item[{unsigned int}]{row\-Stop}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_aa8d0393323104d48c089a8429b254689}
{\bfseries Returns\-:} A G\-Cell\-T {\bf Hurricane} collection that contains the part of {\ttfamily column} starting from {\ttfamily row\-Start} to {\ttfamily row\-Stop} inclusive. 

Referenced by Katabatic\-Engine\-::create\-Detailed\-Grid().

\hypertarget{classKatabatic_1_1Grid_a35e2075302cdb696945f05c5bcc817a0}{\index{Katabatic\-::\-Grid@{Katabatic\-::\-Grid}!get\-G\-Cells\-Row@{get\-G\-Cells\-Row}}
\index{get\-G\-Cells\-Row@{get\-G\-Cells\-Row}!Katabatic::Grid@{Katabatic\-::\-Grid}}
\subsubsection[{get\-G\-Cells\-Row}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Generic\-Collection}$<$ C\-Gell\-T $\ast$ $>$ get\-G\-Cells\-Row (
\begin{DoxyParamCaption}
\item[{unsigned int}]{row, }
\item[{unsigned int}]{column\-Start, }
\item[{unsigned int}]{column\-Stop}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1Grid_a35e2075302cdb696945f05c5bcc817a0}
{\bfseries Returns\-:} A G\-Cell\-T {\bf Hurricane} collection that contains the part of {\ttfamily row} starting from {\ttfamily column\-Start} to {\ttfamily column\-Stop} inclusive. 

Referenced by Katabatic\-Engine\-::create\-Detailed\-Grid().



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