\hypertarget{descriptions_8ic}{
\section{descriptions.ic File Reference}
\label{descriptions_8ic}\index{descriptions.ic@{descriptions.ic}}
}
Static inline functions that calculate some simple component properties. 

{\tt \#include \char`\"{}AG\_\-descriptions\_\-s.h\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par


Include dependency graph for descriptions.ic:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=138pt]{descriptions_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=111pt]{descriptions_8ic__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static size\_\-t \hyperlink{descriptions_8ic_a0}{sizeof\-Cpt} (const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$cd)
\begin{CompactList}\small\item\em Returns the volume of the component. \item\end{CompactList}\item 
static void \hyperlink{descriptions_8ic_a1}{clear\-Cpt} (void $\ast$cpt, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$cd)
\begin{CompactList}\small\item\em Clears all the bits of the data block, assuming that it is described by the \hyperlink{structCptDescription}{Cpt\-Description}. \item\end{CompactList}\item 
static void \hyperlink{descriptions_8ic_a2}{copy\-Cpt} (void $\ast$cpt, const void $\ast$source, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$cd)
\begin{CompactList}\small\item\em Copy from {\em source\/} to {\em dest\/}. \item\end{CompactList}\item 
static int \hyperlink{descriptions_8ic_a3}{compare\-Cpt} (const void $\ast$cpt, const void $\ast$that, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$cd)
\begin{CompactList}\small\item\em Compare two components. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Static inline functions that calculate some simple component properties. 

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


\subsection{Function Documentation}
\hypertarget{descriptions_8ic_a1}{
\index{descriptions.ic@{descriptions.ic}!clearCpt@{clearCpt}}
\index{clearCpt@{clearCpt}!descriptions.ic@{descriptions.ic}}
\subsubsection[clearCpt]{\setlength{\rightskip}{0pt plus 5cm}void clear\-Cpt (void $\ast$ {\em cpt}, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$ {\em cd})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{descriptions_8ic_a1}


Clears all the bits of the data block, assuming that it is described by the \hyperlink{structCptDescription}{Cpt\-Description}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpt}]Pointer to start of the component data \item[{\em cd}]Description of the component registers\end{description}
\end{Desc}
\hypertarget{descriptions_8ic_a3}{
\index{descriptions.ic@{descriptions.ic}!compareCpt@{compareCpt}}
\index{compareCpt@{compareCpt}!descriptions.ic@{descriptions.ic}}
\subsubsection[compareCpt]{\setlength{\rightskip}{0pt plus 5cm}int compare\-Cpt (const void $\ast$ {\em this}, const void $\ast$ {\em that}, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$ {\em cd})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{descriptions_8ic_a3}


Compare two components. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em this}]Pointer to one of the components being compared \item[{\em that}]Pointer to the other component be compared \item[{\em cd}]Description of the component registers \end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em 0}]if identical \item[{\em non-zero}]if different\end{description}
\end{Desc}
\hypertarget{descriptions_8ic_a2}{
\index{descriptions.ic@{descriptions.ic}!copyCpt@{copyCpt}}
\index{copyCpt@{copyCpt}!descriptions.ic@{descriptions.ic}}
\subsubsection[copyCpt]{\setlength{\rightskip}{0pt plus 5cm}void copy\-Cpt (void $\ast$ {\em dest}, const void $\ast$ {\em source}, const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$ {\em cd})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{descriptions_8ic_a2}


Copy from {\em source\/} to {\em dest\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dest}]Destination to copy to \item[{\em source}]Place to copy from \item[{\em cd}]Description of the component registers\end{description}
\end{Desc}
\hypertarget{descriptions_8ic_a0}{
\index{descriptions.ic@{descriptions.ic}!sizeofCpt@{sizeofCpt}}
\index{sizeofCpt@{sizeofCpt}!descriptions.ic@{descriptions.ic}}
\subsubsection[sizeofCpt]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t sizeof\-Cpt (const \hyperlink{structCptDescription}{Cpt\-Description} $\ast$ {\em cd})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{descriptions_8ic_a0}


Returns the volume of the component. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cd}]Description of the component registers \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Size of data volume required to hold the component\end{Desc}