185 lines
10 KiB
TeX
185 lines
10 KiB
TeX
\hypertarget{classKatabatic_1_1BaseGrid}{\section{Base\-Grid Class Reference}
|
|
\label{classKatabatic_1_1BaseGrid}\index{Base\-Grid@{Base\-Grid}}
|
|
}
|
|
|
|
|
|
Abstract Base Class for Irregular \hyperlink{classKatabatic_1_1Grid}{Grid}.
|
|
|
|
|
|
|
|
|
|
Inheritance diagram for Base\-Grid\-:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=257pt]{classKatabatic_1_1BaseGrid__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis}
|
|
\begin{DoxyCompactList}\small\item\em Graduations on a \hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid} \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis} (H or V). \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \hyperlink{classKatabatic_1_1BaseGrid_a3a80b6032f86a56bec74609034b3246f}{destroy} ()
|
|
\item
|
|
const {\bf Box} \& \hyperlink{classKatabatic_1_1BaseGrid_a895132a706d822c43d6ec747c3266f74}{get\-Bounding\-Box} () const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_ae2bf24a99431664bb5897b122bb15b43}{get\-Columns} () const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_ab7e3c454272e9a8f2c803e24454d7303}{get\-Rows} () const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_ac25c519161036ae2d004fcc78abf7856}{get\-Raw\-Size} () const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_a5ffadea177995aedb4152f58b9dd391d}{get\-Index} (unsigned int c, unsigned int r) const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_a3a813e40c392fb62c5b1b86d11f1dcb4}{get\-Row} (unsigned int) const
|
|
\item
|
|
unsigned int \hyperlink{classKatabatic_1_1BaseGrid_a3ae31ad99809b916f386fe9bde67c6f2}{get\-Column} (unsigned int) const
|
|
\item
|
|
const \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis} \& \hyperlink{classKatabatic_1_1BaseGrid_a5731a526d261c2fa798a2c836cfeb9d1}{get\-X\-Grads} () const
|
|
\item
|
|
const \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis} \& \hyperlink{classKatabatic_1_1BaseGrid_a40fe4841176c132346564b3d4c942668}{get\-Y\-Grads} () const
|
|
\end{DoxyCompactItemize}
|
|
\subsection*{Protected Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\hyperlink{classKatabatic_1_1BaseGrid_ac479157e8ac115074615167e8a4a2789}{Base\-Grid} (const {\bf Box} \&)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
Abstract Base Class for Irregular \hyperlink{classKatabatic_1_1Grid}{Grid}.
|
|
|
|
An abstract class for a 2-\/\-D matrix of objects. The grid is irregular in the sense that the horizontal and vertical cut lines may not be evenly spaced.
|
|
|
|
The coordinates of cut lines in horizontal and vertical direction are stored \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Base\-Grid\-::\-Axis} structure.
|
|
|
|
The \hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid} contains all the non-\/template methods of the \hyperlink{classKatabatic_1_1Grid}{Grid}, that is that do not depend of the matrix element type.
|
|
|
|
The internal storage implemented in derived classes is expected to store \char`\"{}row by row\char`\"{} (rows are put one after another in the vector).
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\hypertarget{classKatabatic_1_1BaseGrid_ac479157e8ac115074615167e8a4a2789}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!Base\-Grid@{Base\-Grid}}
|
|
\index{Base\-Grid@{Base\-Grid}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{Base\-Grid}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Base\-Grid} (
|
|
\begin{DoxyParamCaption}
|
|
\item[{const {\bf Box} \&}]{bb}
|
|
\end{DoxyParamCaption}
|
|
)\hspace{0.3cm}{\ttfamily [protected]}}}\label{classKatabatic_1_1BaseGrid_ac479157e8ac115074615167e8a4a2789}
|
|
Construct a new \hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid} on area {\ttfamily bb}. Graduations, rows \& columns are sets to zero.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\hypertarget{classKatabatic_1_1BaseGrid_a3a80b6032f86a56bec74609034b3246f}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!destroy@{destroy}}
|
|
\index{destroy@{destroy}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{destroy}]{\setlength{\rightskip}{0pt plus 5cm}void destroy (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a3a80b6032f86a56bec74609034b3246f}
|
|
The user-\/level destructor. \hypertarget{classKatabatic_1_1BaseGrid_a895132a706d822c43d6ec747c3266f74}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Bounding\-Box@{get\-Bounding\-Box}}
|
|
\index{get\-Bounding\-Box@{get\-Bounding\-Box}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Bounding\-Box}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf Box} \& get\-Bounding\-Box (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a895132a706d822c43d6ec747c3266f74}
|
|
{\bfseries Returns\-:} The grid bounding box. \hypertarget{classKatabatic_1_1BaseGrid_ae2bf24a99431664bb5897b122bb15b43}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Columns@{get\-Columns}}
|
|
\index{get\-Columns@{get\-Columns}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Columns}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Columns (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_ae2bf24a99431664bb5897b122bb15b43}
|
|
{\bfseries Returns\-:} The numbers of columns in the grid.
|
|
|
|
Referenced by G\-Cell\-Grid\-::\-\_\-post\-Create(), Katabatic\-Engine\-::create\-Detailed\-Grid(), Base\-Grid\-::get\-Column(), Base\-Grid\-::get\-Index(), Base\-Grid\-::get\-Raw\-Size(), and Base\-Grid\-::get\-Row().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_ab7e3c454272e9a8f2c803e24454d7303}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Rows@{get\-Rows}}
|
|
\index{get\-Rows@{get\-Rows}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Rows}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Rows (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_ab7e3c454272e9a8f2c803e24454d7303}
|
|
{\bfseries Returns\-:} The numbers of rows in the grid.
|
|
|
|
Referenced by G\-Cell\-Grid\-::\-\_\-post\-Create(), Katabatic\-Engine\-::create\-Detailed\-Grid(), and Base\-Grid\-::get\-Raw\-Size().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_ac25c519161036ae2d004fcc78abf7856}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Raw\-Size@{get\-Raw\-Size}}
|
|
\index{get\-Raw\-Size@{get\-Raw\-Size}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Raw\-Size}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Raw\-Size (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_ac25c519161036ae2d004fcc78abf7856}
|
|
{\bfseries Returns\-:} The total number of elements in the grid (i.\-e. $ rows \times columns $)
|
|
|
|
References Base\-Grid\-::get\-Columns(), and Base\-Grid\-::get\-Rows().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_a5ffadea177995aedb4152f58b9dd391d}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Index@{get\-Index}}
|
|
\index{get\-Index@{get\-Index}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Index}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Index (
|
|
\begin{DoxyParamCaption}
|
|
\item[{unsigned int}]{c, }
|
|
\item[{unsigned int}]{r}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a5ffadea177995aedb4152f58b9dd391d}
|
|
An helper function that compute the linear index in the element vector from a {\ttfamily }(c,r) coordinate pair\-: \[ index = c + r \times columns \]
|
|
|
|
References Base\-Grid\-::get\-Columns().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_a3a813e40c392fb62c5b1b86d11f1dcb4}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Row@{get\-Row}}
|
|
\index{get\-Row@{get\-Row}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Row}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Row (
|
|
\begin{DoxyParamCaption}
|
|
\item[{unsigned int}]{i}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a3a813e40c392fb62c5b1b86d11f1dcb4}
|
|
An helper function that compute the row number from the linear index in the vector\-: \[ row = index / columns \]
|
|
|
|
References Base\-Grid\-::get\-Columns().
|
|
|
|
|
|
|
|
Referenced by G\-Cell\-::get\-Row().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_a3ae31ad99809b916f386fe9bde67c6f2}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Column@{get\-Column}}
|
|
\index{get\-Column@{get\-Column}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Column}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int get\-Column (
|
|
\begin{DoxyParamCaption}
|
|
\item[{unsigned int}]{i}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a3ae31ad99809b916f386fe9bde67c6f2}
|
|
An helper function that compute the column number from the linear index in the vector\-: \[ column = index \div columns \]
|
|
|
|
References Base\-Grid\-::get\-Columns().
|
|
|
|
|
|
|
|
Referenced by G\-Cell\-::get\-Column().
|
|
|
|
\hypertarget{classKatabatic_1_1BaseGrid_a5731a526d261c2fa798a2c836cfeb9d1}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-X\-Grads@{get\-X\-Grads}}
|
|
\index{get\-X\-Grads@{get\-X\-Grads}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-X\-Grads}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf Axis} \& get\-X\-Grads (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a5731a526d261c2fa798a2c836cfeb9d1}
|
|
{\bfseries Returns\-:} The graduations on the X axis. \hypertarget{classKatabatic_1_1BaseGrid_a40fe4841176c132346564b3d4c942668}{\index{Katabatic\-::\-Base\-Grid@{Katabatic\-::\-Base\-Grid}!get\-Y\-Grads@{get\-Y\-Grads}}
|
|
\index{get\-Y\-Grads@{get\-Y\-Grads}!Katabatic::BaseGrid@{Katabatic\-::\-Base\-Grid}}
|
|
\subsubsection[{get\-Y\-Grads}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf Axis} \& get\-Y\-Grads (
|
|
\begin{DoxyParamCaption}
|
|
{}
|
|
\end{DoxyParamCaption}
|
|
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKatabatic_1_1BaseGrid_a40fe4841176c132346564b3d4c942668}
|
|
{\bfseries Returns\-:} The graduations on the Y axis.
|
|
|
|
The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
|
|
\item
|
|
Grid.\-h\item
|
|
Grid.\-cpp\item
|
|
Grid.\-dox\end{DoxyCompactItemize}
|