\hypertarget{bndl_8h}{
\section{bndl.h File Reference}
\label{bndl_8h}\index{bndl.h@{bndl.h}}
}
Defines public methods for creating/accessing channel bundles.  


\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{bndl_8h_a0}{
typedef \_\-chnl\-Bndl $\ast$ \hyperlink{bndl_8h_a0}{bndl\-Handle}}
\label{bndl_8h_a0}

\begin{CompactList}\small\item\em Typedef for struct \_\-chnl\-Bndl$\ast$. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{bndl_8h_a1}{g\-Bndl\-Clear} (\hyperlink{struct__gnat}{gnat\-Handle} gh)
\begin{CompactList}\small\item\em zeroes out the bundle array \item\end{CompactList}\item 
int \hyperlink{bndl_8h_a2}{g\-Bndl\-Add\-Chnl} (\hyperlink{struct__gnat}{gnat\-Handle} gh, unsigned char chnl\-Num, unsigned int n\-Chnl\-Data, unsigned int $\ast$chnl\-Data)
\begin{CompactList}\small\item\em Inserts the bits pointed to by {\em chnl\-Data\/} into channel {\em chnl\-Num\/} of the channel bundle. \item\end{CompactList}\item 
int \hyperlink{bndl_8h_a3}{g\-Bndl\-Get\-Depth} (\hyperlink{struct__gnat}{gnat\-Handle} gh, unsigned int $\ast$depth32)
\begin{CompactList}\small\item\em Returns the depth of the bunlde {\em bh\/} in the pointer {\em depth\/}. \item\end{CompactList}\item 
int \hyperlink{bndl_8h_a4}{g\-Bndl\-Get\-Chnl} (\hyperlink{struct__gnat}{gnat\-Handle} gh, unsigned char chnl\-Num, unsigned int n\-Chnl\-Data, unsigned int $\ast$chnl\-Data)
\begin{CompactList}\small\item\em Retrieves the bits contained in channel number {\em chnl\-Num\/} of bundle in {\em gh\/}. \item\end{CompactList}\item 
unsigned short $\ast$ \hyperlink{bndl_8h_a5}{g\-Bndl\-Get\-Bndl} (\hyperlink{struct__gnat}{gnat\-Handle} gh)
\begin{CompactList}\small\item\em returns pointer to bundle storage \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Defines public methods for creating/accessing channel bundles. 

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


\subsection{Function Documentation}
\hypertarget{bndl_8h_a2}{
\index{bndl.h@{bndl.h}!gBndlAddChnl@{gBndlAddChnl}}
\index{gBndlAddChnl@{gBndlAddChnl}!bndl.h@{bndl.h}}
\subsubsection[gBndlAddChnl]{\setlength{\rightskip}{0pt plus 5cm}int g\-Bndl\-Add\-Chnl (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, unsigned char {\em chnl\-Num}, unsigned int {\em n\-Chnl\-Data}, unsigned int $\ast$ {\em p\-Chnl\-Data})}}
\label{bndl_8h_a2}


Inserts the bits pointed to by {\em chnl\-Data\/} into channel {\em chnl\-Num\/} of the channel bundle. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]gnat driver handle previously allocated \item[{\em chnl\-Num}]the channel in the bundle that {\em chnl\-Data\/} is to be inserted into (0-15) \item[{\em n\-Chnl\-Data}]the number of 32-bit words in {\em p\-Chnl\-Data\/} \item[{\em p\-Chnl\-Data}]a pointer to the channel bits. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if close successful \end{Desc}
\begin{Desc}
\item[See also:]\hyperlink{bndl_8c_a4}{g\-Bndl\-Get\-Chnl()}\end{Desc}
The number of unsigned ints in {\em p\-Chnl\-Data\/} must be less than or equal to the bundle depth of {\em gh\/}, i.e. if {\em p\-Chnl\-Data\/} points to two unsigned ints (64 bits) then depth of {\em gh\/} must be two 32-entry blocks (64 entries total) or greater. \hypertarget{bndl_8h_a1}{
\index{bndl.h@{bndl.h}!gBndlClear@{gBndlClear}}
\index{gBndlClear@{gBndlClear}!bndl.h@{bndl.h}}
\subsubsection[gBndlClear]{\setlength{\rightskip}{0pt plus 5cm}int g\-Bndl\-Clear (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{bndl_8h_a1}


zeroes out the bundle array 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]gnat driver handle previously allocated \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if close successful \end{Desc}
\hypertarget{bndl_8h_a5}{
\index{bndl.h@{bndl.h}!gBndlGetBndl@{gBndlGetBndl}}
\index{gBndlGetBndl@{gBndlGetBndl}!bndl.h@{bndl.h}}
\subsubsection[gBndlGetBndl]{\setlength{\rightskip}{0pt plus 5cm}unsigned short$\ast$ g\-Bndl\-Get\-Bndl (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{bndl_8h_a5}


returns pointer to bundle storage 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]gnat driver handle previously allocated \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]pointer to bunlde storage or NULL \end{Desc}
\hypertarget{bndl_8h_a4}{
\index{bndl.h@{bndl.h}!gBndlGetChnl@{gBndlGetChnl}}
\index{gBndlGetChnl@{gBndlGetChnl}!bndl.h@{bndl.h}}
\subsubsection[gBndlGetChnl]{\setlength{\rightskip}{0pt plus 5cm}int g\-Bndl\-Get\-Chnl (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, unsigned char {\em chnl\-Num}, unsigned int {\em n\-Chnl\-Data}, unsigned int $\ast$ {\em p\-Chnl\-Data})}}
\label{bndl_8h_a4}


Retrieves the bits contained in channel number {\em chnl\-Num\/} of bundle in {\em gh\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]gnat driver handle previously allocated \item[{\em chnl\-Num}]the channel number in the bundle {\em bh\/} to fetch. \item[{\em n\-Chnl\-Data}]the number of 32-bit words to fetch and store in {\em p\-Chnl\-Data\/} \item[{\em p\-Chnl\-Data}]a pointer to store to hold the channel bits. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if close successful \end{Desc}
\begin{Desc}
\item[See also:]\hyperlink{bndl_8c_a3}{g\-Bndl\-Add\-Chnl()}\end{Desc}
The number of unsigned ints {\em n\-Chnl\-Data\/} in {\em p\-Chnl\-Data\/} must be less than or equal to the bundle depth of @ gh, i.e. if {\em gh\/} has a depth of 2 {\em n\-Chnl\-Data\/} can be 2 or 1. \hypertarget{bndl_8h_a3}{
\index{bndl.h@{bndl.h}!gBndlGetDepth@{gBndlGetDepth}}
\index{gBndlGetDepth@{gBndlGetDepth}!bndl.h@{bndl.h}}
\subsubsection[gBndlGetDepth]{\setlength{\rightskip}{0pt plus 5cm}int g\-Bndl\-Get\-Depth (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, unsigned int $\ast$ {\em depth})}}
\label{bndl_8h_a3}


Returns the depth of the bunlde {\em bh\/} in the pointer {\em depth\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]gnat driver handle previously allocated \item[{\em depth}]output parameter used to return the depth of {\em bh\/} \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if close successful \end{Desc}