\section{TPProto::Board Class Reference}
\label{classTPProto_1_1Board}\index{TPProto::Board@{TPProto::Board}}
\doxyref{Board}{p.}{classTPProto_1_1Board} \doxyref{Frame}{p.}{classTPProto_1_1Frame} class.  


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

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

\begin{CompactList}\small\item\em Default Constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Board} ()\label{classTPProto_1_1Board_5e3dc867b8d1d09a5c7d5345069b843a}

\begin{CompactList}\small\item\em Virtual destructor as required. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Packs the board into a buffer. \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpacks a board from a buffer. \item\end{CompactList}\item 
unsigned int {\bf get\-Id} ()
\begin{CompactList}\small\item\em Gets the board's id number. \item\end{CompactList}\item 
std::string {\bf get\-Name} ()
\begin{CompactList}\small\item\em Gets the board's name. \item\end{CompactList}\item 
std::string {\bf get\-Description} ()
\begin{CompactList}\small\item\em Gets the board's description. \item\end{CompactList}\item 
int {\bf num\-Messages} ()
\begin{CompactList}\small\item\em Get the number of messages on the board. \item\end{CompactList}\item 
uint64\_\-t {\bf get\-Last\-Modified\-Time} ()
\begin{CompactList}\small\item\em Gets the last time this board was modified. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
\doxyref{Board}{p.}{classTPProto_1_1Board} \doxyref{Frame}{p.}{classTPProto_1_1Frame} class. 

The \doxyref{Board}{p.}{classTPProto_1_1Board} class is the representation of the board \doxyref{Frame}{p.}{classTPProto_1_1Frame}, and provides an interface to the boards. 



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


Packs the board into a buffer. 

Currently assets(0). Should not be used, sending boards to the server is not needed at this time. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The buffer to pack into. \end{description}
\end{Desc}


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


Unpacks a board from a buffer. 

Unpacks a buffer, setting the values given by the server. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The buffer to unpack from. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if successful. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::Board@{TPProto::Board}!getId@{getId}}
\index{getId@{getId}!TPProto::Board@{TPProto::Board}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned int TPProto::Board::get\-Id ()}\label{classTPProto_1_1Board_fea20f368a08cdb631e5d68dea7f6255}


Gets the board's id number. 

\begin{Desc}
\item[Returns:]The \doxyref{Board}{p.}{classTPProto_1_1Board} ID number. \end{Desc}
\index{TPProto::Board@{TPProto::Board}!getName@{getName}}
\index{getName@{getName}!TPProto::Board@{TPProto::Board}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Board::get\-Name ()}\label{classTPProto_1_1Board_269008241beebe538789cfa4196fe051}


Gets the board's name. 

\begin{Desc}
\item[Returns:]The board's name. \end{Desc}
\index{TPProto::Board@{TPProto::Board}!getDescription@{getDescription}}
\index{getDescription@{getDescription}!TPProto::Board@{TPProto::Board}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Board::get\-Description ()}\label{classTPProto_1_1Board_bf4951b9c1ffcf66ae15443d411ef1f8}


Gets the board's description. 

\begin{Desc}
\item[Returns:]The board's description. \end{Desc}
\index{TPProto::Board@{TPProto::Board}!numMessages@{numMessages}}
\index{numMessages@{numMessages}!TPProto::Board@{TPProto::Board}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int TPProto::Board::num\-Messages ()}\label{classTPProto_1_1Board_8274dd2b336e8461ca052aeb42845fe7}


Get the number of messages on the board. 

The id of the messages are 0 to \doxyref{num\-Messages()}{p.}{classTPProto_1_1Board_8274dd2b336e8461ca052aeb42845fe7} - 1. \begin{Desc}
\item[Returns:]The number of messages. \end{Desc}
\index{TPProto::Board@{TPProto::Board}!getLastModifiedTime@{getLastModifiedTime}}
\index{getLastModifiedTime@{getLastModifiedTime}!TPProto::Board@{TPProto::Board}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Board::get\-Last\-Modified\-Time ()}\label{classTPProto_1_1Board_bee891e3203d020fc0b8789fe0122580}


Gets the last time this board was modified. 

\begin{Desc}
\item[Returns:]The timestamp of the last modification time. \end{Desc}


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