\hypertarget{data_8ic}{
\section{data.ic File Reference}
\label{data_8ic}\index{data.ic@{data.ic}}
}
Set and get field and register functions. 

{\tt \#include \char`\"{}PBI/Endianness.h\char`\"{}}\par
{\tt \#include \char`\"{}descriptions.ic\char`\"{}}\par


Include dependency graph for data.ic:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=186pt]{data_8ic__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=83pt]{data_8ic__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static void \hyperlink{data_8ic_a0}{set\-Long\-Reg} (unsigned $\ast$cpt, int reg\-Id, const unsigned $\ast$value)
\begin{CompactList}\small\item\em Assumes the registers are unsigned ints and Sets the {\em reg\-Idister\/} of {\em cpt\/} structure to {\em value\/}. \item\end{CompactList}\item 
static void \hyperlink{data_8ic_a1}{set\-Long\-Fld} (unsigned $\ast$cpt, const \hyperlink{structFldDescription}{Fld\-Description} $\ast$fd, int reg\-Id, int fld\-Id, const unsigned $\ast$value)
\begin{CompactList}\small\item\em Assumes the registers are unsigned ints and sets the {\em tgt\-Fiels\/} of the {\em register\/} of {\em cpt\/} structure to {\em value\/}. \item\end{CompactList}\item 
static void \hyperlink{data_8ic_a2}{get\-Long\-Reg} (const unsigned $\ast$cpt, int reg\-Id, unsigned $\ast$value)
\begin{CompactList}\small\item\em Assumes the registers are unsigned ints and puts the contents of the target register {\em reg\-Id\/} into {\em value\/}. \item\end{CompactList}\item 
static void \hyperlink{data_8ic_a3}{get\-Long\-Fld} (const unsigned $\ast$cpt, const \hyperlink{structFldDescription}{Fld\-Description} $\ast$fd, int reg\-Id, int fld\-Id, unsigned $\ast$value)
\begin{CompactList}\small\item\em Assumes the registers are unsigned ints and puts the contents of the target register {\em reg\-Id\/} into {\em value\/}. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Set and get field and register functions. 

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


\subsection{Function Documentation}
\hypertarget{data_8ic_a3}{
\index{data.ic@{data.ic}!getLongFld@{getLongFld}}
\index{getLongFld@{getLongFld}!data.ic@{data.ic}}
\subsubsection[getLongFld]{\setlength{\rightskip}{0pt plus 5cm}void get\-Long\-Fld (const unsigned $\ast$ {\em cpt}, const \hyperlink{structFldDescription}{Fld\-Description} $\ast$ {\em fd}, int {\em reg\-Id}, int {\em fld\-Id}, unsigned $\ast$ {\em value})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{data_8ic_a3}


Assumes the registers are unsigned ints and puts the contents of the target register {\em reg\-Id\/} into {\em value\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpt}]Pointer to start of the component data. \item[{\em fd}]Description of the register fields \item[{\em reg\-Id}]Target tgt \item[{\em fld\-Id}]Target field \item[{\em value}]Location to put the contents of the target tgt\end{description}
\end{Desc}
\hypertarget{data_8ic_a2}{
\index{data.ic@{data.ic}!getLongReg@{getLongReg}}
\index{getLongReg@{getLongReg}!data.ic@{data.ic}}
\subsubsection[getLongReg]{\setlength{\rightskip}{0pt plus 5cm}void get\-Long\-Reg (const unsigned $\ast$ {\em cpt}, int {\em reg\-Id}, unsigned $\ast$ {\em value})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{data_8ic_a2}


Assumes the registers are unsigned ints and puts the contents of the target register {\em reg\-Id\/} into {\em value\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpt}]Pointer to start of the component data. \item[{\em reg\-Id}]Target tgt \item[{\em value}]Location to put the contents of the target tgt\end{description}
\end{Desc}
\hypertarget{data_8ic_a1}{
\index{data.ic@{data.ic}!setLongFld@{setLongFld}}
\index{setLongFld@{setLongFld}!data.ic@{data.ic}}
\subsubsection[setLongFld]{\setlength{\rightskip}{0pt plus 5cm}void set\-Long\-Fld (unsigned $\ast$ {\em cpt}, const \hyperlink{structFldDescription}{Fld\-Description} $\ast$ {\em fd}, int {\em reg\-Id}, int {\em fld\-Id}, const unsigned $\ast$ {\em value})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{data_8ic_a1}


Assumes the registers are unsigned ints and sets the {\em tgt\-Fiels\/} of the {\em register\/} of {\em cpt\/} structure to {\em value\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpt}]Pointer to start of the component data. \item[{\em fd}]Description of the fields in the register \item[{\em reg\-Id}]Enum specifying register to write to (previously bounds checked) \item[{\em fld\-Id}]Enum specifying field to write to (previously bounds checked) \item[{\em value}]Set the target registers to cpt.\end{description}
\end{Desc}
\hypertarget{data_8ic_a0}{
\index{data.ic@{data.ic}!setLongReg@{setLongReg}}
\index{setLongReg@{setLongReg}!data.ic@{data.ic}}
\subsubsection[setLongReg]{\setlength{\rightskip}{0pt plus 5cm}void set\-Long\-Reg (unsigned $\ast$ {\em cpt}, int {\em reg\-Id}, const unsigned $\ast$ {\em value})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{data_8ic_a0}


Assumes the registers are unsigned ints and Sets the {\em reg\-Idister\/} of {\em cpt\/} structure to {\em value\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpt}]Pointer to start of the component data. \item[{\em reg\-Id}]Enum specifing register to write to (previously bounds checked) \item[{\em value}]Set the target registers to cpt.\end{description}
\end{Desc}