\hypertarget{QPIG_8h}{
\section{QPIG.h File Reference}
\label{QPIG_8h}\index{QPIG.h@{QPIG.h}}
}
Interface to power state updating routines. 

{\tt \#include \char`\"{}QPIG/state.h\char`\"{}}\par
{\tt \#include \char`\"{}LSF/LSF.h\char`\"{}}\par


Include dependency graph for QPIG.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=145pt]{QPIG_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=89pt]{QPIG_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QPIG_8h_a0}{
typedef \hyperlink{struct__QPIG}{\_\-QPIG} \hyperlink{QPIG_8h_a0}{QPIG}}
\label{QPIG_8h_a0}

\begin{CompactList}\small\item\em Data type for QPIG context block. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{struct__QPIG}{QPIG} $\ast$ \hyperlink{QPIG_8h_a1}{QPIG\_\-alloc} (void)
\begin{CompactList}\small\item\em Allocate and construct the QPIG context block. \item\end{CompactList}\item 
\hyperlink{struct__QPIG}{QPIG} $\ast$ \hyperlink{QPIG_8h_a2}{QPIG\_\-construct} (\hyperlink{struct__QPIG}{QPIG} $\ast$qpig, void $\ast$prm)
\begin{CompactList}\small\item\em Construct (initialize) the QPIG context block. \item\end{CompactList}\item 
void \hyperlink{QPIG_8h_a3}{QPIG\_\-destruct} (\hyperlink{struct__QPIG}{QPIG} $\ast$qpig)
\begin{CompactList}\small\item\em Destroy the QPIG context block. \item\end{CompactList}\item 
unsigned int \hyperlink{QPIG_8h_a4}{QPIG\_\-sizeof} (void $\ast$prm)
\begin{CompactList}\small\item\em Return the size, in bytes, of the QPIG context block. \item\end{CompactList}\item 
const \hyperlink{struct__QPIG__state}{QPIG\_\-state} $\ast$ \hyperlink{QPIG_8h_a5}{QPIG\_\-state\-Get} (const \hyperlink{struct__QPIG}{QPIG} $\ast$qpig)
\begin{CompactList}\small\item\em Return the address of the QPIG register state data. \item\end{CompactList}\item 
void \hyperlink{QPIG_8h_a6}{QPIG\_\-update\-At\-Datagram} (\hyperlink{struct__QPIG}{QPIG} $\ast$qpig, const LSF\_\-datagram $\ast$dgm)
\begin{CompactList}\small\item\em Update the register state information in the QPIG context. \item\end{CompactList}\item 
int \hyperlink{QPIG_8h_a7}{QPIG\_\-version\-Get} (const \hyperlink{struct__QPIG}{QPIG} $\ast$qpig)
\begin{CompactList}\small\item\em Return the version of the QPIG register state data. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Interface to power state updating routines. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{QPIG_8h}{QPIG.h},v 1.3 2009/02/20 22:57:54 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{QPIG_8h_a1}{
\index{QPIG.h@{QPIG.h}!QPIG_alloc@{QPIG\_\-alloc}}
\index{QPIG_alloc@{QPIG\_\-alloc}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-alloc]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__QPIG}{QPIG}$\ast$ QPIG\_\-alloc (void)}}
\label{QPIG_8h_a1}


Allocate and construct the QPIG context block. 

\begin{Desc}
\item[Returns:]A pointer to the new QPIG context block (context handle)\end{Desc}
\hypertarget{QPIG_8h_a2}{
\index{QPIG.h@{QPIG.h}!QPIG_construct@{QPIG\_\-construct}}
\index{QPIG_construct@{QPIG\_\-construct}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-construct]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__QPIG}{QPIG}$\ast$ QPIG\_\-construct (\hyperlink{struct__QPIG}{QPIG} $\ast$ {\em qpig}, void $\ast$ {\em prm})}}
\label{QPIG_8h_a2}


Construct (initialize) the QPIG context block. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qpig}]The block to initialize; if specified as NULL, one will be allocated.\item[{\em prm}]A run-time set parameter used to stylize the configuration (not used)\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The QPIG context handle\end{Desc}
\hypertarget{QPIG_8h_a3}{
\index{QPIG.h@{QPIG.h}!QPIG_destruct@{QPIG\_\-destruct}}
\index{QPIG_destruct@{QPIG\_\-destruct}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-destruct]{\setlength{\rightskip}{0pt plus 5cm}void QPIG\_\-destruct (\hyperlink{struct__QPIG}{QPIG} $\ast$ {\em qpig})}}
\label{QPIG_8h_a3}


Destroy the QPIG context block. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qpig}]The QPIG context handle.\end{description}
\end{Desc}
\hypertarget{QPIG_8h_a4}{
\index{QPIG.h@{QPIG.h}!QPIG_sizeof@{QPIG\_\-sizeof}}
\index{QPIG_sizeof@{QPIG\_\-sizeof}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}unsigned int QPIG\_\-sizeof (void $\ast$ {\em prm})}}
\label{QPIG_8h_a4}


Return the size, in bytes, of the QPIG context block. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em prm}]A run-time set parameter used to stylize the configuration\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The size, in bytes, of the context block\end{Desc}
\hypertarget{QPIG_8h_a5}{
\index{QPIG.h@{QPIG.h}!QPIG_stateGet@{QPIG\_\-stateGet}}
\index{QPIG_stateGet@{QPIG\_\-stateGet}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-stateGet]{\setlength{\rightskip}{0pt plus 5cm}const \hyperlink{struct__QPIG__state}{QPIG\_\-state}$\ast$ QPIG\_\-state\-Get (const \hyperlink{struct__QPIG}{QPIG} $\ast$ {\em qpig})}}
\label{QPIG_8h_a5}


Return the address of the QPIG register state data. 

This routine is just an accessor to keep the structure of QPIG private.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qpig}]The QPIG context handle\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A pointer to the QPIG register state data\end{Desc}
\hypertarget{QPIG_8h_a6}{
\index{QPIG.h@{QPIG.h}!QPIG_updateAtDatagram@{QPIG\_\-updateAtDatagram}}
\index{QPIG_updateAtDatagram@{QPIG\_\-updateAtDatagram}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-updateAtDatagram]{\setlength{\rightskip}{0pt plus 5cm}void QPIG\_\-update\-At\-Datagram (\hyperlink{struct__QPIG}{QPIG} $\ast$ {\em qpig}, const LSF\_\-datagram $\ast$ {\em dgm})}}
\label{QPIG_8h_a6}


Update the register state information in the QPIG context. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qpig}]The QPIG context handle\item[{\em dgm}]The PIG register state datagram\end{description}
\end{Desc}
\hypertarget{QPIG_8h_a7}{
\index{QPIG.h@{QPIG.h}!QPIG_versionGet@{QPIG\_\-versionGet}}
\index{QPIG_versionGet@{QPIG\_\-versionGet}!QPIG.h@{QPIG.h}}
\subsubsection[QPIG\_\-versionGet]{\setlength{\rightskip}{0pt plus 5cm}int QPIG\_\-version\-Get (const \hyperlink{struct__QPIG}{QPIG} $\ast$ {\em qpig})}}
\label{QPIG_8h_a7}


Return the version of the QPIG register state data. 

This routine is just an accessor to keep the structure of QPIG private.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qpig}]The QPIG context handle\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The version of the QPIG register state data\end{Desc}