\section{TPProto::Get\-Message Class Reference}
\label{classTPProto_1_1GetMessage}\index{TPProto::GetMessage@{TPProto::GetMessage}}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to get Messages from one board on the server.  


{\tt \#include $<$getmessage.h$>$}

Inheritance diagram for TPProto::Get\-Message::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classTPProto_1_1GetMessage}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Get\-Message} ()\label{classTPProto_1_1GetMessage_9564e781a2de0be2f54a5951ee93e6e2}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Get\-Message} ()\label{classTPProto_1_1GetMessage_660e5fa94bf55249590d01799b6bce25}

\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Pack this \doxyref{Get\-Message}{p.}{classTPProto_1_1GetMessage} \doxyref{Frame}{p.}{classTPProto_1_1Frame} into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, always false. \item\end{CompactList}\item 
void {\bf set\-Board} (unsigned int board)\label{classTPProto_1_1GetMessage_2aab4ee2a0860a1b78f0ac4322e27233}

\begin{CompactList}\small\item\em Sets the \doxyref{Board}{p.}{classTPProto_1_1Board} id of the \doxyref{Board}{p.}{classTPProto_1_1Board} the Messages are on. /param board The board id number. \item\end{CompactList}\item 
void {\bf add\-Message\-Id} (unsigned int id)
\begin{CompactList}\small\item\em Adds a single \doxyref{Message}{p.}{classTPProto_1_1Message} id to get. \item\end{CompactList}\item 
void {\bf add\-Message\-Ids} (std::set$<$ unsigned int $>$ ids)
\begin{CompactList}\small\item\em Adds a set of \doxyref{Message}{p.}{classTPProto_1_1Message} ids to the set to request. \item\end{CompactList}\item 
void {\bf add\-Message\-Range} (unsigned int start, unsigned int end)
\begin{CompactList}\small\item\em Adds a range of \doxyref{Message}{p.}{classTPProto_1_1Message} ids to the set to request. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to get Messages from one board on the server. 



\subsection{Member Function Documentation}
\index{TPProto::GetMessage@{TPProto::Get\-Message}!packBuffer@{packBuffer}}
\index{packBuffer@{packBuffer}!TPProto::GetMessage@{TPProto::Get\-Message}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Message::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1GetMessage_29cca28a45ca98247f71ac2d3e61df0b}


Pack this \doxyref{Get\-Message}{p.}{classTPProto_1_1GetMessage} \doxyref{Frame}{p.}{classTPProto_1_1Frame} into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into. \end{description}
\end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}.\index{TPProto::GetMessage@{TPProto::Get\-Message}!unpackBuffer@{unpackBuffer}}
\index{unpackBuffer@{unpackBuffer}!TPProto::GetMessage@{TPProto::Get\-Message}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Get\-Message::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1GetMessage_eb279fb610397d6a484dd94c88b64a6d}


Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, always false. 

Since \doxyref{Get\-Message}{p.}{classTPProto_1_1GetMessage} frames are only sent to the server, we should not receive them and therefore this method always returns false. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, ignored. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]False always. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::GetMessage@{TPProto::Get\-Message}!addMessageId@{addMessageId}}
\index{addMessageId@{addMessageId}!TPProto::GetMessage@{TPProto::Get\-Message}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Message::add\-Message\-Id (unsigned int {\em id})}\label{classTPProto_1_1GetMessage_bc5545b9d213a8ba127722ad4ff6bc09}


Adds a single \doxyref{Message}{p.}{classTPProto_1_1Message} id to get. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The message id to get. \end{description}
\end{Desc}
\index{TPProto::GetMessage@{TPProto::Get\-Message}!addMessageIds@{addMessageIds}}
\index{addMessageIds@{addMessageIds}!TPProto::GetMessage@{TPProto::Get\-Message}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Message::add\-Message\-Ids (std::set$<$ unsigned int $>$ {\em ids})}\label{classTPProto_1_1GetMessage_4e35706d75624981586a729946c02ae8}


Adds a set of \doxyref{Message}{p.}{classTPProto_1_1Message} ids to the set to request. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ids}]The set of message ids to get. \end{description}
\end{Desc}
\index{TPProto::GetMessage@{TPProto::Get\-Message}!addMessageRange@{addMessageRange}}
\index{addMessageRange@{addMessageRange}!TPProto::GetMessage@{TPProto::Get\-Message}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Message::add\-Message\-Range (unsigned int {\em start}, unsigned int {\em end})}\label{classTPProto_1_1GetMessage_b2e0b5477acb437abc30d6c7f323ca22}


Adds a range of \doxyref{Message}{p.}{classTPProto_1_1Message} ids to the set to request. 

The range is inclusive of the start id, and exclusive of the end. This allows clients to get all messages by going add\-Message\-Range(0, board-$>$num\-Messages()). \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]The first message id to get. \item[{\em end}]One greater than the last message id to get. \end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
tpproto/{\bf getmessage.h}\item 
tpproto/getmessage.cpp\end{CompactItemize}