\hypertarget{gnat_8h}{
\section{gnat.h File Reference}
\label{gnat_8h}\index{gnat.h@{gnat.h}}
}
Defines public aspects of the GNAT driver.  


{\tt \#include \char`\"{}GNAT/gerr.h\char`\"{}}\par


Include dependency graph for gnat.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=56pt]{gnat_8h__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=215pt]{gnat_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{gnat_8h_a0}{MAX\_\-BNDL\_\-DEPTH}\ (5)
\begin{CompactList}\small\item\em Maximum depth of a channel bundle. \item\end{CompactList}\item 
\#define \hyperlink{gnat_8h_a1}{MAX\_\-CHANNEL}\ (15)
\begin{CompactList}\small\item\em Maximum out going channel number. \item\end{CompactList}\item 
\#define \hyperlink{gnat_8h_a2}{\_\-CHECK}(status)
\begin{CompactList}\small\item\em Checks if the status value is G\_\-OK, returns if not. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{gnat_8h_a3}{
typedef \hyperlink{struct__gnat}{\_\-gnat} $\ast$ \hyperlink{gnat_8h_a3}{gnat\-Handle}}
\label{gnat_8h_a3}

\begin{CompactList}\small\item\em Typedef for struct \_\-gnat$\ast$. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Defines public aspects of the GNAT driver. 

\begin{Desc}
\item[Author:]Curt Brune -- \href{mailto:curt@slac.stanford.edu}{\tt curt@slac.stanford.edu}\end{Desc}


\subsection{Define Documentation}
\hypertarget{gnat_8h_a2}{
\index{gnat.h@{gnat.h}!_CHECK@{\_\-CHECK}}
\index{_CHECK@{\_\-CHECK}!gnat.h@{gnat.h}}
\subsubsection[\_\-CHECK]{\setlength{\rightskip}{0pt plus 5cm}\#define \_\-CHECK(status)}}
\label{gnat_8h_a2}


{\bf Value:}

\footnotesize\begin{verbatim}if ( (status) != G_OK ) {                       \
  return status;                                \
}
\end{verbatim}\normalsize 
Checks if the status value is G\_\-OK, returns if not. 

\hypertarget{gnat_8h_a0}{
\index{gnat.h@{gnat.h}!MAX_BNDL_DEPTH@{MAX\_\-BNDL\_\-DEPTH}}
\index{MAX_BNDL_DEPTH@{MAX\_\-BNDL\_\-DEPTH}!gnat.h@{gnat.h}}
\subsubsection[MAX\_\-BNDL\_\-DEPTH]{\setlength{\rightskip}{0pt plus 5cm}\#define MAX\_\-BNDL\_\-DEPTH\ (5)}}
\label{gnat_8h_a0}


Maximum depth of a channel bundle. 

5 is deep enough to hold 1 cell -- That's enough space for 5 $\ast$ 32 bits of serial information. 1 cell is 128 bits ( 4 $\ast$ 32 ). \hypertarget{gnat_8h_a1}{
\index{gnat.h@{gnat.h}!MAX_CHANNEL@{MAX\_\-CHANNEL}}
\index{MAX_CHANNEL@{MAX\_\-CHANNEL}!gnat.h@{gnat.h}}
\subsubsection[MAX\_\-CHANNEL]{\setlength{\rightskip}{0pt plus 5cm}\#define MAX\_\-CHANNEL\ (15)}}
\label{gnat_8h_a1}


Maximum out going channel number. 

Valid channel numbers range from 0 to MAX\_\-CHANNEL. 