\hypertarget{consume_8c}{
\section{consume.c File Reference}
\label{consume_8c}\index{consume.c@{consume.c}}
}
File read and write functions. 

{\tt \#include \char`\"{}consume.h\char`\"{}}\par
{\tt \#include \char`\"{}fi\_\-p.h\char`\"{}}\par
{\tt \#include \char`\"{}error.h\char`\"{}}\par
{\tt \#include \char`\"{}RIM/rim.h\char`\"{}}\par
{\tt \#include $<$fcntl.h$>$}\par
{\tt \#include $<$unistd.h$>$}\par


Include dependency graph for consume.c:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=206pt]{consume_8c__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned \hyperlink{consume_8c_a0}{QCFG\_\-consume\-Map} (RIM\_\-map $\ast$map, const char $\ast$filename)
\begin{CompactList}\small\item\em Read map data into the map structure. \item\end{CompactList}\item 
unsigned \hyperlink{consume_8c_a1}{QCFG\_\-consume} (RIM $\ast$rim, char $\ast$$\ast$filelist, int nfiles)
\begin{CompactList}\small\item\em Reads a configuration, as described by the configuration master file {\em cfg\-Name\/}, into the {\em latc\/} structure. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
File read and write functions. 

\begin{Desc}
\item[Author:]James Swain -- \href{mailto:jswain@slac.stanford.edu}{\tt jswain@slac.stanford.edu}\end{Desc}


\subsection{Function Documentation}
\hypertarget{consume_8c_a1}{
\index{consume.c@{consume.c}!QCFG_consume@{QCFG\_\-consume}}
\index{QCFG_consume@{QCFG\_\-consume}!consume.c@{consume.c}}
\subsubsection[QCFG\_\-consume]{\setlength{\rightskip}{0pt plus 5cm}unsigned QCFG\_\-consume (RIM $\ast$ {\em rim}, char $\ast$$\ast$ {\em filelist}, int {\em nfiles})}}
\label{consume_8c_a1}


Reads a configuration, as described by the configuration master file {\em cfg\-Name\/}, into the {\em latc\/} structure. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em rim}]Pointer to the RIM to repopulate with the configuration information \item[{\em filelist}]List of binary configuration files \item[{\em nfiles}]Number of binary configuration files\end{description}
\end{Desc}
\hypertarget{consume_8c_a0}{
\index{consume.c@{consume.c}!QCFG_consumeMap@{QCFG\_\-consumeMap}}
\index{QCFG_consumeMap@{QCFG\_\-consumeMap}!consume.c@{consume.c}}
\subsubsection[QCFG\_\-consumeMap]{\setlength{\rightskip}{0pt plus 5cm}unsigned QCFG\_\-consume\-Map (RIM\_\-map $\ast$ {\em map}, const char $\ast$ {\em filename})}}
\label{consume_8c_a0}


Read map data into the map structure. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map structure to populate from file \item[{\em filename}]Name of the binary map file to consume \end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QCFG\_\-SUCCESS}]if all goes well \item[{\em RIM\_\-FILE\_\-OPEN}]if the fid, or any of the names the configuration master file contains, does not match a valid file. \item[{\em RIM\_\-FILE\_\-READ}]if an error occures whilst the file is being read\end{description}
\end{Desc}
