diff options
Diffstat (limited to 'doc/latex/structcUPnPObjectID.tex')
| -rw-r--r-- | doc/latex/structcUPnPObjectID.tex | 274 |
1 files changed, 274 insertions, 0 deletions
diff --git a/doc/latex/structcUPnPObjectID.tex b/doc/latex/structcUPnPObjectID.tex new file mode 100644 index 0000000..b5b6ce9 --- /dev/null +++ b/doc/latex/structcUPnPObjectID.tex @@ -0,0 +1,274 @@ +\hypertarget{structcUPnPObjectID}{ +\section{cUPnPObjectID Struct Reference} +\label{structcUPnPObjectID}\index{cUPnPObjectID@{cUPnPObjectID}} +} +{\tt \#include $<$object.h$>$} + +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +\hyperlink{structcUPnPObjectID_c2ee8d12b2b317fa430e9107f1870efe}{cUPnPObjectID} () +\item +\hyperlink{structcUPnPObjectID_baeac468c4117f2fac4e3d93f3de9730}{cUPnPObjectID} (long ID) +\item +\hyperlink{structcUPnPObjectID_f3e044892ae1c1d840d4154ab96a2440}{cUPnPObjectID} (int ID) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \& \hyperlink{structcUPnPObjectID_747dfcfad52baae471cc756bed63a6e8}{operator=} (long ID) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \& \hyperlink{structcUPnPObjectID_b83af995ac5e03b6f6402d83a6713960}{operator=} (int ID) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \& \hyperlink{structcUPnPObjectID_9d2adc7bcee2e5b1d51aa7ffc385296f}{operator=} (const \hyperlink{structcUPnPObjectID}{cUPnPObjectID} \&ID) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \& \hyperlink{structcUPnPObjectID_c347bd50efed28fda02f98da46114786}{operator++} () +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \hyperlink{structcUPnPObjectID_d46000a3acdd6f522bf3b86e48d47ddf}{operator++} (int) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \hyperlink{structcUPnPObjectID_3e6872234bfd011a720b7847190dfdb9}{operator--} (int) +\item +\hyperlink{structcUPnPObjectID}{cUPnPObjectID} \& \hyperlink{structcUPnPObjectID_40864616e14e4b5c98ff274098402be7}{operator--} () +\item +bool \hyperlink{structcUPnPObjectID_25b1f5cd4eb080cc4ab53731e1bd75f1}{operator!=} (long ID) +\item +bool \hyperlink{structcUPnPObjectID_b612ccd98af29996a4ac15cdbf01320f}{operator==} (long ID) +\item +bool \hyperlink{structcUPnPObjectID_5183bfe859555d90c7bc7abd576d0980}{operator!=} (int ID) +\item +bool \hyperlink{structcUPnPObjectID_18cf7d50a8ae1b6d2034e88fef78e23f}{operator==} (int ID) +\item +bool \hyperlink{structcUPnPObjectID_d55b5dc94c58d56762c602de5dd99790}{operator!=} (const \hyperlink{structcUPnPObjectID}{cUPnPObjectID} \&ID) +\item +bool \hyperlink{structcUPnPObjectID_54cb3e4ab1b340c9580e915dbf9319a1}{operator==} (const \hyperlink{structcUPnPObjectID}{cUPnPObjectID} \&ID) +\item +\hyperlink{structcUPnPObjectID_daa4eae524c68f1f85b8d82d16568d10}{operator unsigned int} () +\item +\hyperlink{structcUPnPObjectID_73ff8d0e18486552dbfbf828a2e7bc7c}{operator int} () +\item +\hyperlink{structcUPnPObjectID_d5659a7a9f7cfc7dd6ae0911ebd5e03c}{operator long} () +\item +const char $\ast$ \hyperlink{structcUPnPObjectID_33e67c6f297892763b5a4a41cd435490}{operator$\ast$} () +\end{CompactItemize} +\subsection*{Public Attributes} +\begin{CompactItemize} +\item +\hypertarget{structcUPnPObjectID_af52b7865459a66369101b7fba35aa0c}{ +int \hyperlink{structcUPnPObjectID_af52b7865459a66369101b7fba35aa0c}{\_\-ID}} +\label{structcUPnPObjectID_af52b7865459a66369101b7fba35aa0c} + +\begin{CompactList}\small\item\em The UPnP Object ID. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Detailed Description} +UPnP Object ID + +This is a UPnP Object ID representation. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{structcUPnPObjectID_c2ee8d12b2b317fa430e9107f1870efe}{ +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{cUPnPObjectID}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::cUPnPObjectID ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_c2ee8d12b2b317fa430e9107f1870efe} + + +Constructor + +Creates invalid ID \hypertarget{structcUPnPObjectID_baeac468c4117f2fac4e3d93f3de9730}{ +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{cUPnPObjectID}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::cUPnPObjectID (long {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_baeac468c4117f2fac4e3d93f3de9730} + + +Constructor + +Creates from long integer \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]new ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_f3e044892ae1c1d840d4154ab96a2440}{ +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\index{cUPnPObjectID@{cUPnPObjectID}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{cUPnPObjectID}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::cUPnPObjectID (int {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_f3e044892ae1c1d840d4154ab96a2440} + + +Constructor + +Creates from integer \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]new ID \end{description} +\end{Desc} + + +\subsection{Member Function Documentation} +\hypertarget{structcUPnPObjectID_73ff8d0e18486552dbfbf828a2e7bc7c}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator int@{operator int}} +\index{operator int@{operator int}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator int}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::operator int ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_73ff8d0e18486552dbfbf828a2e7bc7c} + + +Casts to int \hypertarget{structcUPnPObjectID_d5659a7a9f7cfc7dd6ae0911ebd5e03c}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator long@{operator long}} +\index{operator long@{operator long}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator long}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::operator long ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_d5659a7a9f7cfc7dd6ae0911ebd5e03c} + + +Casts to long \hypertarget{structcUPnPObjectID_daa4eae524c68f1f85b8d82d16568d10}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator unsigned int@{operator unsigned int}} +\index{operator unsigned int@{operator unsigned int}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator unsigned int}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectID::operator unsigned int ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_daa4eae524c68f1f85b8d82d16568d10} + + +Casts to unsigned int \hypertarget{structcUPnPObjectID_d55b5dc94c58d56762c602de5dd99790}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator!=@{operator!=}} +\index{operator!=@{operator!=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator!= (const {\bf cUPnPObjectID} \& {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_d55b5dc94c58d56762c602de5dd99790} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_5183bfe859555d90c7bc7abd576d0980}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator!=@{operator!=}} +\index{operator!=@{operator!=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator!= (int {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_5183bfe859555d90c7bc7abd576d0980} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_25b1f5cd4eb080cc4ab53731e1bd75f1}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator!=@{operator!=}} +\index{operator!=@{operator!=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator!= (long {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_25b1f5cd4eb080cc4ab53731e1bd75f1} + + +Not equal \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_33e67c6f297892763b5a4a41cd435490}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator$\ast$@{operator$\ast$}} +\index{operator$\ast$@{operator$\ast$}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator$\ast$}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPObjectID::operator$\ast$ ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_33e67c6f297892763b5a4a41cd435490} + + +Casts to string \hypertarget{structcUPnPObjectID_d46000a3acdd6f522bf3b86e48d47ddf}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator++@{operator++}} +\index{operator++@{operator++}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator++}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID} cUPnPObjectID::operator++ (int)\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_d46000a3acdd6f522bf3b86e48d47ddf} + + +Post increment the ID \hypertarget{structcUPnPObjectID_c347bd50efed28fda02f98da46114786}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator++@{operator++}} +\index{operator++@{operator++}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator++}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID}\& cUPnPObjectID::operator++ ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_c347bd50efed28fda02f98da46114786} + + +Pre increment the ID \hypertarget{structcUPnPObjectID_40864616e14e4b5c98ff274098402be7}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator--@{operator--}} +\index{operator--@{operator--}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator--}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID}\& cUPnPObjectID::operator-- ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_40864616e14e4b5c98ff274098402be7} + + +Pre decrement the ID \hypertarget{structcUPnPObjectID_3e6872234bfd011a720b7847190dfdb9}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator--@{operator--}} +\index{operator--@{operator--}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator--}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID} cUPnPObjectID::operator-- (int)\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_3e6872234bfd011a720b7847190dfdb9} + + +Post decrement the ID \hypertarget{structcUPnPObjectID_9d2adc7bcee2e5b1d51aa7ffc385296f}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator=@{operator=}} +\index{operator=@{operator=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID}\& cUPnPObjectID::operator= (const {\bf cUPnPObjectID} \& {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_9d2adc7bcee2e5b1d51aa7ffc385296f} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]new ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_b83af995ac5e03b6f6402d83a6713960}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator=@{operator=}} +\index{operator=@{operator=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID}\& cUPnPObjectID::operator= (int {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_b83af995ac5e03b6f6402d83a6713960} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]new ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_747dfcfad52baae471cc756bed63a6e8}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator=@{operator=}} +\index{operator=@{operator=}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPObjectID}\& cUPnPObjectID::operator= (long {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_747dfcfad52baae471cc756bed63a6e8} + + +Set the object ID \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]new ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_54cb3e4ab1b340c9580e915dbf9319a1}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator==@{operator==}} +\index{operator==@{operator==}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator== (const {\bf cUPnPObjectID} \& {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_54cb3e4ab1b340c9580e915dbf9319a1} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_18cf7d50a8ae1b6d2034e88fef78e23f}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator==@{operator==}} +\index{operator==@{operator==}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator== (int {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_18cf7d50a8ae1b6d2034e88fef78e23f} + + +This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} +\hypertarget{structcUPnPObjectID_b612ccd98af29996a4ac15cdbf01320f}{ +\index{cUPnPObjectID@{cUPnPObjectID}!operator==@{operator==}} +\index{operator==@{operator==}!cUPnPObjectID@{cUPnPObjectID}} +\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPObjectID::operator== (long {\em ID})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{structcUPnPObjectID_b612ccd98af29996a4ac15cdbf01320f} + + +Equal \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ID}]compare with this ID \end{description} +\end{Desc} + + +The documentation for this struct was generated from the following file:\begin{CompactItemize} +\item +database/object.h\end{CompactItemize} |