\hypertarget{classCisOutput}{}\section{Cis\+Output Class Reference}
\label{classCisOutput}\index{Cis\+Output@{Cis\+Output}}


C++ interface to cis\+Output\+\_\+t functionality.  




{\ttfamily \#include $<$Cis\+Interface.\+hpp$>$}

Inheritance diagram for Cis\+Output\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.976471cm]{classCisOutput}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classCisOutput_acbe5281010e3dd4617006a03d9c6c06c}{Cis\+Output}} (const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Constructor for \mbox{\hyperlink{classCisOutput}{Cis\+Output}}. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classCisOutput_a276eaee68d97cba54726752784d6c4df}{Cis\+Output}} (const char $\ast$name, const char $\ast$fmt)
\begin{DoxyCompactList}\small\item\em Constructor for \mbox{\hyperlink{classCisOutput}{Cis\+Output}} with format. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisOutput_abf373bf8e55beb4b32d558463b134a51}\label{classCisOutput_abf373bf8e55beb4b32d558463b134a51}} 
\mbox{\hyperlink{classCisOutput_abf373bf8e55beb4b32d558463b134a51}{Cis\+Output}} (cis\+Output\+\_\+t x)
\begin{DoxyCompactList}\small\item\em Empty constructor for inheritance. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisOutput_af977def262b778702e06277f5d50f102}\label{classCisOutput_af977def262b778702e06277f5d50f102}} 
void \mbox{\hyperlink{classCisOutput_af977def262b778702e06277f5d50f102}{\+\_\+destroy\+\_\+pi}} ()
\begin{DoxyCompactList}\small\item\em Alias to allow freeing of underlying C struct at the class level. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisOutput_a7dc7c92d8c50f61075d1ef0cf0dfce8f}\label{classCisOutput_a7dc7c92d8c50f61075d1ef0cf0dfce8f}} 
\mbox{\hyperlink{classCisOutput_a7dc7c92d8c50f61075d1ef0cf0dfce8f}{$\sim$\+Cis\+Output}} ()
\begin{DoxyCompactList}\small\item\em Destructor for \mbox{\hyperlink{classCisOutput}{Cis\+Output}}. See cis\+\_\+free in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
cis\+Output\+\_\+t \mbox{\hyperlink{classCisOutput_a173ffd20bb1ce255ba95562caa220d6a}{pi}} ()
\begin{DoxyCompactList}\small\item\em Return the cis\+Output\+\_\+t structure. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisOutput_a38322e95e9743e4b5b5d4c529d13031e}{send}} (const char $\ast$data, const size\+\_\+t len)
\begin{DoxyCompactList}\small\item\em Send a message smaller than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. If the message is larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX an error code will be returned. See cis\+\_\+send in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisOutput_ad30d4a8e64e7a9b7033cddf4a3aef9de}{send}} (const int nargs,...)
\begin{DoxyCompactList}\small\item\em Format and send a message smaller than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisOutput_a794b0e4d24de72339faab690554db4d3}{send\+\_\+nolimit}} (const char $\ast$data, const size\+\_\+t len)
\begin{DoxyCompactList}\small\item\em Send a message larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+\_\+send\+\_\+nolimit in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisOutput_a5b7e84b70352f3a5f99650184a076564}{send\+\_\+nolimit}} (const int nargs,...)
\begin{DoxyCompactList}\small\item\em Format and send a message larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisOutput_a083fb17afbb3c03f103929850506e545}{send\+\_\+eof}} ()
\begin{DoxyCompactList}\small\item\em Send E\+OF message to output file, closing it. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
C++ interface to cis\+Output\+\_\+t functionality. 

The \mbox{\hyperlink{classCisOutput}{Cis\+Output}} class is a basic wrapper around the C cis\+Output\+\_\+t structure and associated functions from the \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} header. It provides the user with C++ style access to basic output via an I\+PC queue. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classCisOutput_acbe5281010e3dd4617006a03d9c6c06c}\label{classCisOutput_acbe5281010e3dd4617006a03d9c6c06c}} 
\index{Cis\+Output@{Cis\+Output}!Cis\+Output@{Cis\+Output}}
\index{Cis\+Output@{Cis\+Output}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{Cis\+Output()}{CisOutput()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Cis\+Output\+::\+Cis\+Output (\begin{DoxyParamCaption}\item[{const char $\ast$}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor for \mbox{\hyperlink{classCisOutput}{Cis\+Output}}. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em name} & constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classCisOutput_a276eaee68d97cba54726752784d6c4df}\label{classCisOutput_a276eaee68d97cba54726752784d6c4df}} 
\index{Cis\+Output@{Cis\+Output}!Cis\+Output@{Cis\+Output}}
\index{Cis\+Output@{Cis\+Output}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{Cis\+Output()}{CisOutput()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Cis\+Output\+::\+Cis\+Output (\begin{DoxyParamCaption}\item[{const char $\ast$}]{name,  }\item[{const char $\ast$}]{fmt }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor for \mbox{\hyperlink{classCisOutput}{Cis\+Output}} with format. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em name} & constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file. \\
\hline
\mbox{\tt in}  & {\em fmt} & character pointer to format string for formatting variables. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{classCisOutput_a173ffd20bb1ce255ba95562caa220d6a}\label{classCisOutput_a173ffd20bb1ce255ba95562caa220d6a}} 
\index{Cis\+Output@{Cis\+Output}!pi@{pi}}
\index{pi@{pi}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{pi()}{pi()}}
{\footnotesize\ttfamily cis\+Output\+\_\+t Cis\+Output\+::pi (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Return the cis\+Output\+\_\+t structure. 

\begin{DoxyReturn}{Returns}
cis\+Output\+\_\+t structure underlying the class. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisOutput_a38322e95e9743e4b5b5d4c529d13031e}\label{classCisOutput_a38322e95e9743e4b5b5d4c529d13031e}} 
\index{Cis\+Output@{Cis\+Output}!send@{send}}
\index{send@{send}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{send()}{send()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily int Cis\+Output\+::send (\begin{DoxyParamCaption}\item[{const char $\ast$}]{data,  }\item[{const size\+\_\+t}]{len }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Send a message smaller than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. If the message is larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX an error code will be returned. See cis\+\_\+send in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em data} & character pointer to message that should be sent. \\
\hline
\mbox{\tt in}  & {\em len} & size\+\_\+t length of message to be sent. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
int 0 if send succesfull, -\/1 if send unsuccessful. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisOutput_ad30d4a8e64e7a9b7033cddf4a3aef9de}\label{classCisOutput_ad30d4a8e64e7a9b7033cddf4a3aef9de}} 
\index{Cis\+Output@{Cis\+Output}!send@{send}}
\index{send@{send}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{send()}{send()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily int Cis\+Output\+::send (\begin{DoxyParamCaption}\item[{const int}]{nargs,  }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Format and send a message smaller than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em nargs} & int Number of arguments being passed. \\
\hline
\mbox{\tt in}  & {\em ...} & arguments for formatting. ~\newline
\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
integer specifying if the send was succesful. Values $>$= 0 indicate success. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisOutput_a083fb17afbb3c03f103929850506e545}\label{classCisOutput_a083fb17afbb3c03f103929850506e545}} 
\index{Cis\+Output@{Cis\+Output}!send\+\_\+eof@{send\+\_\+eof}}
\index{send\+\_\+eof@{send\+\_\+eof}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{send\+\_\+eof()}{send\_eof()}}
{\footnotesize\ttfamily int Cis\+Output\+::send\+\_\+eof (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Send E\+OF message to output file, closing it. 

\begin{DoxyReturn}{Returns}
int 0 if send was succesfull. All other values indicate errors. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisOutput_a794b0e4d24de72339faab690554db4d3}\label{classCisOutput_a794b0e4d24de72339faab690554db4d3}} 
\index{Cis\+Output@{Cis\+Output}!send\+\_\+nolimit@{send\+\_\+nolimit}}
\index{send\+\_\+nolimit@{send\+\_\+nolimit}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{send\+\_\+nolimit()}{send\_nolimit()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily int Cis\+Output\+::send\+\_\+nolimit (\begin{DoxyParamCaption}\item[{const char $\ast$}]{data,  }\item[{const size\+\_\+t}]{len }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Send a message larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+\_\+send\+\_\+nolimit in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em data} & character pointer to message that should be sent. \\
\hline
\mbox{\tt in}  & {\em len} & size\+\_\+t length of message to be sent. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
int 0 if send succesfull, -\/1 if send unsuccessful. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisOutput_a5b7e84b70352f3a5f99650184a076564}\label{classCisOutput_a5b7e84b70352f3a5f99650184a076564}} 
\index{Cis\+Output@{Cis\+Output}!send\+\_\+nolimit@{send\+\_\+nolimit}}
\index{send\+\_\+nolimit@{send\+\_\+nolimit}!Cis\+Output@{Cis\+Output}}
\subsubsection{\texorpdfstring{send\+\_\+nolimit()}{send\_nolimit()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily int Cis\+Output\+::send\+\_\+nolimit (\begin{DoxyParamCaption}\item[{const int}]{nargs,  }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Format and send a message larger than C\+I\+S\+\_\+\+M\+S\+G\+\_\+\+M\+AX to the output queue. See cis\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em nargs} & int Number of arguments being passed. \\
\hline
\mbox{\tt in}  & {\em ...} & arguments for formatting. ~\newline
\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
integer specifying if the send was succesful. Values $>$= 0 indicate success. 
\end{DoxyReturn}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/root/cis\+\_\+interface/cis\+\_\+interface/cis\+\_\+interface/interface/Cis\+Interface.\+hpp\end{DoxyCompactItemize}
