2018-08-19 06:27:09 -05:00
\hypertarget { classKatabatic_ 1_ 1BaseGrid} { \section { Base\- Grid Class Reference}
\label { classKatabatic_ 1_ 1BaseGrid} \index { Base\- Grid@{ Base\- Grid} }
}
2018-06-06 11:42:26 -05:00
Abstract Base Class for Irregular \hyperlink { classKatabatic_ 1_ 1Grid} { Grid} .
2018-08-19 06:27:09 -05:00
Inheritance diagram for Base\- Grid\- :\nopagebreak
2018-06-06 11:42:26 -05:00
\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}
2018-08-19 06:27:09 -05:00
\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}
2018-06-06 11:42:26 -05:00
\subsection * { Public Member Functions}
\begin { DoxyCompactItemize}
\item
void \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a3a80b6032f86a56bec74609034b3246f} { destroy} ()
\item
2018-08-19 06:27:09 -05:00
const { \bf Box} \& \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a895132a706d822c43d6ec747c3266f74} { get\- Bounding\- Box} () const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ ae2bf24a99431664bb5897b122bb15b43} { get\- Columns} () const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ ab7e3c454272e9a8f2c803e24454d7303} { get\- Rows} () const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ ac25c519161036ae2d004fcc78abf7856} { get\- Raw\- Size} () const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a5ffadea177995aedb4152f58b9dd391d} { get\- Index} (unsigned int c, unsigned int r) const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a3a813e40c392fb62c5b1b86d11f1dcb4} { get\- Row} (unsigned int) const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a3ae31ad99809b916f386fe9bde67c6f2} { get\- Column} (unsigned int) const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
const \hyperlink { classKatabatic_ 1_ 1BaseGrid_ 1_ 1Axis} { Axis} \& \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a5731a526d261c2fa798a2c836cfeb9d1} { get\- X\- Grads} () const
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
const \hyperlink { classKatabatic_ 1_ 1BaseGrid_ 1_ 1Axis} { Axis} \& \hyperlink { classKatabatic_ 1_ 1BaseGrid_ a40fe4841176c132346564b3d4c942668} { get\- Y\- Grads} () const
2018-06-06 11:42:26 -05:00
\end { DoxyCompactItemize}
\subsection * { Protected Member Functions}
\begin { DoxyCompactItemize}
\item
2018-08-19 06:27:09 -05:00
\hyperlink { classKatabatic_ 1_ 1BaseGrid_ ac479157e8ac115074615167e8a4a2789} { Base\- Grid} (const { \bf Box} \& )
2018-06-06 11:42:26 -05:00
\end { DoxyCompactItemize}
\subsection { Detailed Description}
Abstract Base Class for Irregular \hyperlink { classKatabatic_ 1_ 1Grid} { Grid} .
2018-08-19 06:27:09 -05:00
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.
2018-06-06 11:42:26 -05:00
2018-08-19 06:27:09 -05:00
The coordinates of cut lines in horizontal and vertical direction are stored \hyperlink { classKatabatic_ 1_ 1BaseGrid_ 1_ 1Axis} { Base\- Grid\- ::\- Axis} structure.
2018-06-06 11:42:26 -05:00
2018-08-19 06:27:09 -05:00
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.
2018-06-06 11:42:26 -05:00
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}
2018-08-19 06:27:09 -05:00
\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.
2018-06-06 11:42:26 -05:00
\subsection { Member Function Documentation}
2018-08-19 06:27:09 -05:00
\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}
2018-06-06 11:42:26 -05:00
\item
2018-08-19 06:27:09 -05:00
Grid.\- h\item
Grid.\- cpp\item
Grid.\- dox\end { DoxyCompactItemize}
