\section{TPProto::Component Class Reference}
\label{classTPProto_1_1Component}\index{TPProto::Component@{TPProto::Component}}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to hold Components from the server.  


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

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

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Component} ()\label{classTPProto_1_1Component_bf2e4aff57b5cb3786dc34fb66a2f304}

\begin{CompactList}\small\item\em Required virtual destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, asserts. \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}. Unpacks the \doxyref{Component}{p.}{classTPProto_1_1Component} frame from the buffer. \item\end{CompactList}\item 
uint32\_\-t {\bf get\-Component\-Id} () const
\begin{CompactList}\small\item\em Gets the \doxyref{Component}{p.}{classTPProto_1_1Component} id. \item\end{CompactList}\item 
uint64\_\-t {\bf get\-Mod\-Time} () const
\begin{CompactList}\small\item\em Gets the last modification time of this \doxyref{Component}{p.}{classTPProto_1_1Component}. \item\end{CompactList}\item 
std::set$<$ uint32\_\-t $>$ {\bf get\-Categories} () const
\begin{CompactList}\small\item\em Gets the categories this \doxyref{Component}{p.}{classTPProto_1_1Component} is in. \item\end{CompactList}\item 
std::string {\bf get\-Name} () const
\begin{CompactList}\small\item\em Gets the name of this \doxyref{Component}{p.}{classTPProto_1_1Component}. \item\end{CompactList}\item 
std::string {\bf get\-Description} () const
\begin{CompactList}\small\item\em Gets the description of this \doxyref{Component}{p.}{classTPProto_1_1Component}. \item\end{CompactList}\item 
std::string {\bf get\-Tpcl\-Requirements\-Func} () const
\begin{CompactList}\small\item\em Gets the TPCL Requirements function for this \doxyref{Component}{p.}{classTPProto_1_1Component}. \item\end{CompactList}\item 
std::map$<$ uint32\_\-t, std::string $>$ {\bf get\-Tpcl\-Property\-Value\-Funcs} () const
\begin{CompactList}\small\item\em Gets the \doxyref{Property}{p.}{classTPProto_1_1Property} instances functions for this \doxyref{Component}{p.}{classTPProto_1_1Component}. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to hold Components from the server. 



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


Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, asserts. 

Packs this \doxyref{Component}{p.}{classTPProto_1_1Component} frame into the buffer. Since the frame only comes from the server, this method assert(0). \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]\doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into, ignored. \end{description}
\end{Desc}


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


Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. Unpacks the \doxyref{Component}{p.}{classTPProto_1_1Component} frame from the buffer. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to unpack out of. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if sucessful, false otherwise. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::Component@{TPProto::Component}!getComponentId@{getComponentId}}
\index{getComponentId@{getComponentId}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Component::get\-Component\-Id () const}\label{classTPProto_1_1Component_3462d78b2a701fde80325e68fac11e21}


Gets the \doxyref{Component}{p.}{classTPProto_1_1Component} id. 

\begin{Desc}
\item[Returns:]The \doxyref{Component}{p.}{classTPProto_1_1Component} id number. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getModTime@{getModTime}}
\index{getModTime@{getModTime}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Component::get\-Mod\-Time () const}\label{classTPProto_1_1Component_5819353feb67ac8b5704fdad126f2246}


Gets the last modification time of this \doxyref{Component}{p.}{classTPProto_1_1Component}. 

\begin{Desc}
\item[Returns:]The modtime. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getCategories@{getCategories}}
\index{getCategories@{getCategories}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::set$<$ uint32\_\-t $>$ TPProto::Component::get\-Categories () const}\label{classTPProto_1_1Component_188fb47455e7f80fac542f244548fb31}


Gets the categories this \doxyref{Component}{p.}{classTPProto_1_1Component} is in. 

\begin{Desc}
\item[Returns:]The set of categories. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getName@{getName}}
\index{getName@{getName}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Component::get\-Name () const}\label{classTPProto_1_1Component_7253489715a8e108e72bea4ae4468070}


Gets the name of this \doxyref{Component}{p.}{classTPProto_1_1Component}. 

\begin{Desc}
\item[Returns:]The name of the \doxyref{Component}{p.}{classTPProto_1_1Component}. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getDescription@{getDescription}}
\index{getDescription@{getDescription}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Component::get\-Description () const}\label{classTPProto_1_1Component_5cd1d242b92add803f07a664f3355dbb}


Gets the description of this \doxyref{Component}{p.}{classTPProto_1_1Component}. 

\begin{Desc}
\item[Returns:]The description of the \doxyref{Component}{p.}{classTPProto_1_1Component}. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getTpclRequirementsFunc@{getTpclRequirementsFunc}}
\index{getTpclRequirementsFunc@{getTpclRequirementsFunc}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Component::get\-Tpcl\-Requirements\-Func () const}\label{classTPProto_1_1Component_43062bef6a0bc0ef10678167440e2a59}


Gets the TPCL Requirements function for this \doxyref{Component}{p.}{classTPProto_1_1Component}. 

\begin{Desc}
\item[Returns:]The TPCL Requirements function for this \doxyref{Component}{p.}{classTPProto_1_1Component}. \end{Desc}
\index{TPProto::Component@{TPProto::Component}!getTpclPropertyValueFuncs@{getTpclPropertyValueFuncs}}
\index{getTpclPropertyValueFuncs@{getTpclPropertyValueFuncs}!TPProto::Component@{TPProto::Component}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::map$<$ uint32\_\-t, std::string $>$ TPProto::Component::get\-Tpcl\-Property\-Value\-Funcs () const}\label{classTPProto_1_1Component_e3198cd2ce4cabb80b5dd3f22a4133b2}


Gets the \doxyref{Property}{p.}{classTPProto_1_1Property} instances functions for this \doxyref{Component}{p.}{classTPProto_1_1Component}. 

\begin{Desc}
\item[Returns:]The map of property id and tpcl value functions for the \doxyref{Component}{p.}{classTPProto_1_1Component}. \end{Desc}


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