152 lines
8.3 KiB
TeX
152 lines
8.3 KiB
TeX
\hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject}{}\doxysection{Gpg\+Frontend\+::Thread\+::Task\+::Data\+Object Class Reference}
|
|
\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject}\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
|
|
|
|
\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject}{Data\+Object}} to be passed to the callback function.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$Task.\+h$>$}
|
|
|
|
|
|
|
|
Collaboration diagram for Gpg\+Frontend\+::Thread\+::Task\+::Data\+Object\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Destructor}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
size\+\_\+t \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_aa35e6ad1ef3a5733fb338f3333b5c637}{Get\+Object\+Size}} ()
|
|
\begin{DoxyCompactList}\small\item\em Get the Objects Size. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename T $>$ }\\void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a521dccfd42e13769b4edc4286318cc4c}{Append\+Object}} (T \&\&obj)
|
|
\item
|
|
{\footnotesize template$<$typename T $>$ }\\T \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a5ef5ddec0b82017cc4ad7f34b9b13f64}{Pop\+Object}} ()
|
|
\item
|
|
\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a85bb3c482bf6f47edcd6593cca568a22}{$\sim$\+Data\+Object}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destroy the Data Object object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Private Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Destructor}} $\ast$ \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a0e1ab5e5bf5ef647a30a5ee2884ac63a}{get\+\_\+heap\+\_\+ptr}} (size\+\_\+t bytes\+\_\+size)
|
|
\begin{DoxyCompactList}\small\item\em Get the heap ptr object. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a17252d07835dab3772381639ec8473ea}{free\+\_\+heap\+\_\+ptr}} (\mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Destructor}} $\ast$)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_add6080349c4774da4f37a62ab68561c7}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_add6080349c4774da4f37a62ab68561c7}}
|
|
std\+::stack$<$ \mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Destructor}} $\ast$ $>$ {\bfseries data\+\_\+objects\+\_\+}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject}{Data\+Object}} to be passed to the callback function.
|
|
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a85bb3c482bf6f47edcd6593cca568a22}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a85bb3c482bf6f47edcd6593cca568a22}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!````~DataObject@{$\sim$DataObject}}
|
|
\index{````~DataObject@{$\sim$DataObject}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{$\sim$DataObject()}{~DataObject()}}
|
|
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::$\sim$\+Data\+Object (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Destroy the Data Object object.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a521dccfd42e13769b4edc4286318cc4c}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a521dccfd42e13769b4edc4286318cc4c}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!AppendObject@{AppendObject}}
|
|
\index{AppendObject@{AppendObject}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{AppendObject()}{AppendObject()}}
|
|
{\footnotesize\ttfamily template$<$typename T $>$ \\
|
|
void Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::\+Append\+Object (\begin{DoxyParamCaption}\item[{T \&\&}]{obj }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
\begin{DoxyTemplParams}{Template Parameters}
|
|
{\em T} & \\
|
|
\hline
|
|
\end{DoxyTemplParams}
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em ptr} & \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a17252d07835dab3772381639ec8473ea}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a17252d07835dab3772381639ec8473ea}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!free\_heap\_ptr@{free\_heap\_ptr}}
|
|
\index{free\_heap\_ptr@{free\_heap\_ptr}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{free\_heap\_ptr()}{free\_heap\_ptr()}}
|
|
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::free\+\_\+heap\+\_\+ptr (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Destructor}} $\ast$}]{ptr }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em heap\+\_\+ptr} & \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a0e1ab5e5bf5ef647a30a5ee2884ac63a}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a0e1ab5e5bf5ef647a30a5ee2884ac63a}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!get\_heap\_ptr@{get\_heap\_ptr}}
|
|
\index{get\_heap\_ptr@{get\_heap\_ptr}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{get\_heap\_ptr()}{get\_heap\_ptr()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor}{Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::\+Destructor}} $\ast$ Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::get\+\_\+heap\+\_\+ptr (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{bytes\+\_\+size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
Get the heap ptr object.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em bytes\+\_\+size} & \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
void$\ast$
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_aa35e6ad1ef3a5733fb338f3333b5c637}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_aa35e6ad1ef3a5733fb338f3333b5c637}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!GetObjectSize@{GetObjectSize}}
|
|
\index{GetObjectSize@{GetObjectSize}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{GetObjectSize()}{GetObjectSize()}}
|
|
{\footnotesize\ttfamily size\+\_\+t Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::\+Get\+Object\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Get the Objects Size.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
size\+\_\+t
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a5ef5ddec0b82017cc4ad7f34b9b13f64}\label{classGpgFrontend_1_1Thread_1_1Task_1_1DataObject_a5ef5ddec0b82017cc4ad7f34b9b13f64}}
|
|
\index{GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}!PopObject@{PopObject}}
|
|
\index{PopObject@{PopObject}!GpgFrontend::Thread::Task::DataObject@{GpgFrontend::Thread::Task::DataObject}}
|
|
\doxysubsubsection{\texorpdfstring{PopObject()}{PopObject()}}
|
|
{\footnotesize\ttfamily template$<$typename T $>$ \\
|
|
T Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Data\+Object\+::\+Pop\+Object (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
\begin{DoxyTemplParams}{Template Parameters}
|
|
{\em T} & \\
|
|
\hline
|
|
\end{DoxyTemplParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
std\+::shared\+\_\+ptr$<$\+T$>$
|
|
\end{DoxyReturn}
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
src/core/thread/Task.\+h\item
|
|
src/core/thread/Task.\+cpp\end{DoxyCompactItemize}
|