diff options
Diffstat (limited to 'doc/latex/classcUPnPObjectMediator.tex')
-rw-r--r-- | doc/latex/classcUPnPObjectMediator.tex | 262 |
1 files changed, 0 insertions, 262 deletions
diff --git a/doc/latex/classcUPnPObjectMediator.tex b/doc/latex/classcUPnPObjectMediator.tex deleted file mode 100644 index 6613879..0000000 --- a/doc/latex/classcUPnPObjectMediator.tex +++ /dev/null @@ -1,262 +0,0 @@ -\hypertarget{classcUPnPObjectMediator}{ -\section{cUPnPObjectMediator Class Reference} -\label{classcUPnPObjectMediator}\index{cUPnPObjectMediator@{cUPnPObjectMediator}} -} -{\tt \#include $<$object.h$>$} - -Inheritance diagram for cUPnPObjectMediator:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[width=400pt]{classcUPnPObjectMediator__inherit__graph} -\end{center} -\end{figure} -Collaboration diagram for cUPnPObjectMediator:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[width=400pt]{classcUPnPObjectMediator__coll__graph} -\end{center} -\end{figure} -\subsection*{Public Member Functions} -\begin{CompactItemize} -\item -virtual \hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$ \hyperlink{classcUPnPObjectMediator_bfbca3f1cbadacee2b21306364750f26}{createObject} (const char $\ast$Title, bool Restricted) -\item -virtual \hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$ \hyperlink{classcUPnPObjectMediator_5b4fff612476fb51690919f9c59899a5}{getObject} (\hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) -\item -virtual int \hyperlink{classcUPnPObjectMediator_c200f88239b8940d9d38cbe04c3e961e}{saveObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) -\item -virtual int \hyperlink{classcUPnPObjectMediator_0d2f9d72a678002456cbdeccb2c6e5fe}{deleteObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) -\item -virtual int \hyperlink{classcUPnPObjectMediator_9ab720e86c6d6cb397799ac5070f70aa}{clearObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) -\end{CompactItemize} -\subsection*{Protected Member Functions} -\begin{CompactItemize} -\item -\hyperlink{classcUPnPObjectMediator_1bc635808c95f6bd774046c37b8139a1}{cUPnPObjectMediator} (\hyperlink{classcMediaDatabase}{cMediaDatabase} $\ast$MediaDatabase) -\item -virtual int \hyperlink{classcUPnPObjectMediator_a5a3c6d0fd0cff8c74e6fc40d723290f}{initializeObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object, const char $\ast$Class, const char $\ast$Title, bool Restricted) -\item -virtual int \hyperlink{classcUPnPObjectMediator_c44c010895f92adc63af2a2d34cf34c8}{objectToDatabase} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) -\item -virtual int \hyperlink{classcUPnPObjectMediator_07a6a1d2694fb2f4573bd50374406b24}{databaseToObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object, \hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) -\end{CompactItemize} -\subsection*{Protected Attributes} -\begin{CompactItemize} -\item -\hypertarget{classcUPnPObjectMediator_e4c8b57a4ebeee1cd55306d436a10541}{ -\hyperlink{classcSQLiteDatabase}{cSQLiteDatabase} $\ast$ \hyperlink{classcUPnPObjectMediator_e4c8b57a4ebeee1cd55306d436a10541}{mDatabase}} -\label{classcUPnPObjectMediator_e4c8b57a4ebeee1cd55306d436a10541} - -\begin{CompactList}\small\item\em the SQLite 3 database wrapper \item\end{CompactList}\item -\hypertarget{classcUPnPObjectMediator_dbdaa3de8276658a0f8d91d24a789ddf}{ -\hyperlink{classcMediaDatabase}{cMediaDatabase} $\ast$ \hyperlink{classcUPnPObjectMediator_dbdaa3de8276658a0f8d91d24a789ddf}{mMediaDatabase}} -\label{classcUPnPObjectMediator_dbdaa3de8276658a0f8d91d24a789ddf} - -\begin{CompactList}\small\item\em the media database \item\end{CompactList}\end{CompactItemize} - - -\subsection{Detailed Description} -Object Mediator - -This is the interface between the objects and the database. It is possible to create new objects, stores objects in the database as well as removing them from it. - -\subsection{Constructor \& Destructor Documentation} -\hypertarget{classcUPnPObjectMediator_1bc635808c95f6bd774046c37b8139a1}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{cUPnPObjectMediator}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPObjectMediator::cUPnPObjectMediator ({\bf cMediaDatabase} $\ast$ {\em MediaDatabase})\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}} -\label{classcUPnPObjectMediator_1bc635808c95f6bd774046c37b8139a1} - - -Constructor of object mediator - -This constructs a new object mediator. This is actually not allowed because it is prohibited to create instances of the UPnP class Object \begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em MediaDatabase}]the media database \end{description} -\end{Desc} - - -\subsection{Member Function Documentation} -\hypertarget{classcUPnPObjectMediator_9ab720e86c6d6cb397799ac5070f70aa}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!clearObject@{clearObject}} -\index{clearObject@{clearObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{clearObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::clearObject ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_9ab720e86c6d6cb397799ac5070f70aa} - - -Clears the object - -This clears the object, i.e. all its children will be removed and deleted from the database - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be cleared \end{description} -\end{Desc} - - -Implements \hyperlink{classcMediatorInterface_cd087c690154d43ac5ef92c5a42f2349}{cMediatorInterface}.\hypertarget{classcUPnPObjectMediator_bfbca3f1cbadacee2b21306364750f26}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!createObject@{createObject}} -\index{createObject@{createObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{createObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassObject} $\ast$ cUPnPObjectMediator::createObject (const char $\ast$ {\em Title}, \/ bool {\em Restricted})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_bfbca3f1cbadacee2b21306364750f26} - - -Creates an object - -This creates a new UPnP object with the specific title and the restriction. - -\begin{Desc} -\item[Returns:]the newly created object \end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Title}]the title of that object \item[{\em Restricted}]the restriction of the object \end{description} -\end{Desc} - - -Implements \hyperlink{classcMediatorInterface_68a8350f7ea5ccd2496580035228b1fc}{cMediatorInterface}. - -Reimplemented in \hyperlink{classcUPnPItemMediator_e2fd4cf5e6435f1eeadd11f9a99cd2db}{cUPnPItemMediator}, \hyperlink{classcUPnPVideoItemMediator_27e001142c3651c36dfd3b7c450414c0}{cUPnPVideoItemMediator}, \hyperlink{classcUPnPVideoBroadcastMediator_14fefa90807d40d91a80712729af2beb}{cUPnPVideoBroadcastMediator}, \hyperlink{classcUPnPMovieMediator_29d40a311b7283cc4fba36860ac8c935}{cUPnPMovieMediator}, and \hyperlink{classcUPnPContainerMediator_751177c725da94b1b91f6cda4645844d}{cUPnPContainerMediator}.\hypertarget{classcUPnPObjectMediator_07a6a1d2694fb2f4573bd50374406b24}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!databaseToObject@{databaseToObject}} -\index{databaseToObject@{databaseToObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{databaseToObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::databaseToObject ({\bf cUPnPClassObject} $\ast$ {\em Object}, \/ {\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_07a6a1d2694fb2f4573bd50374406b24} - - -Loads an object from database - -This loads an object from the database - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be loaded \item[{\em ID}]the object ID of that object \end{description} -\end{Desc} - - -Reimplemented in \hyperlink{classcUPnPItemMediator_1f3645ebe0a33a81d0b3f22060dc4761}{cUPnPItemMediator}, \hyperlink{classcUPnPVideoItemMediator_3f7ec1937b2b95e3ec5462470971d350}{cUPnPVideoItemMediator}, \hyperlink{classcUPnPVideoBroadcastMediator_33237e5d850c107d37be37c1646b17d7}{cUPnPVideoBroadcastMediator}, \hyperlink{classcUPnPMovieMediator_542135e9c1051b57a8f6f5ecc0c1ede3}{cUPnPMovieMediator}, and \hyperlink{classcUPnPContainerMediator_79f483b48f596047ed9549f0b036f35b}{cUPnPContainerMediator}.\hypertarget{classcUPnPObjectMediator_0d2f9d72a678002456cbdeccb2c6e5fe}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!deleteObject@{deleteObject}} -\index{deleteObject@{deleteObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{deleteObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::deleteObject ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_0d2f9d72a678002456cbdeccb2c6e5fe} - - -Deletes the object - -This deletes the object in the database by removing all its children and then deleting the contents from the database - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be deleted \end{description} -\end{Desc} - - -Implements \hyperlink{classcMediatorInterface_ffbddb7fe72554b9cde9d02648cf8f0e}{cMediatorInterface}.\hypertarget{classcUPnPObjectMediator_5b4fff612476fb51690919f9c59899a5}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!getObject@{getObject}} -\index{getObject@{getObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{getObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassObject} $\ast$ cUPnPObjectMediator::getObject ({\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_5b4fff612476fb51690919f9c59899a5} - - -Get an object - -Retrieves a UPnP object from the database and stores its information in the object. The object is obtained via its object ID. - -\begin{Desc} -\item[Returns:]the object, found in the database \end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em ID}]the object ID \end{description} -\end{Desc} - - -Implements \hyperlink{classcMediatorInterface_716ad95bf6ac5a10e9409ced7a63a9d8}{cMediatorInterface}. - -Reimplemented in \hyperlink{classcUPnPItemMediator_81411b2a472ade71d73a9c8ddc2a7990}{cUPnPItemMediator}, \hyperlink{classcUPnPVideoItemMediator_dd8927340a69d247965ef9250adefb21}{cUPnPVideoItemMediator}, \hyperlink{classcUPnPVideoBroadcastMediator_c13bf0f008f49b0ab499542391998a24}{cUPnPVideoBroadcastMediator}, \hyperlink{classcUPnPMovieMediator_d85b240eb54efd9ab46c440b51c71e83}{cUPnPMovieMediator}, and \hyperlink{classcUPnPContainerMediator_78b71f96fb4289dc78f897d6282078d6}{cUPnPContainerMediator}.\hypertarget{classcUPnPObjectMediator_a5a3c6d0fd0cff8c74e6fc40d723290f}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!initializeObject@{initializeObject}} -\index{initializeObject@{initializeObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{initializeObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::initializeObject ({\bf cUPnPClassObject} $\ast$ {\em Object}, \/ const char $\ast$ {\em Class}, \/ const char $\ast$ {\em Title}, \/ bool {\em Restricted})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_a5a3c6d0fd0cff8c74e6fc40d723290f} - - -Initializes an object - -This initializes an object, which means, that it will be created in the database with the required details. - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be initialized \item[{\em Class}]the class of the object \item[{\em Title}]the title of the object \item[{\em Restricted}]restriction of the object \end{description} -\end{Desc} -\hypertarget{classcUPnPObjectMediator_c44c010895f92adc63af2a2d34cf34c8}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!objectToDatabase@{objectToDatabase}} -\index{objectToDatabase@{objectToDatabase}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{objectToDatabase}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::objectToDatabase ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_c44c010895f92adc63af2a2d34cf34c8} - - -Store the object in the database - -This stores the information of an object in the database - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be saved \end{description} -\end{Desc} - - -Reimplemented in \hyperlink{classcUPnPItemMediator_6d954b1cfdc4a7d55981c6ebff9d6d04}{cUPnPItemMediator}, \hyperlink{classcUPnPVideoItemMediator_984e10738bca46ce38307d5f60e26bd3}{cUPnPVideoItemMediator}, \hyperlink{classcUPnPVideoBroadcastMediator_822f9c93928a7dbe9491c8cccbf53f95}{cUPnPVideoBroadcastMediator}, \hyperlink{classcUPnPMovieMediator_61ab6dcaf2417898428ddf1f635788b7}{cUPnPMovieMediator}, and \hyperlink{classcUPnPContainerMediator_1caa4625fca42940ba36999a71ac49ec}{cUPnPContainerMediator}.\hypertarget{classcUPnPObjectMediator_c200f88239b8940d9d38cbe04c3e961e}{ -\index{cUPnPObjectMediator@{cUPnPObjectMediator}!saveObject@{saveObject}} -\index{saveObject@{saveObject}!cUPnPObjectMediator@{cUPnPObjectMediator}} -\subsubsection[{saveObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPObjectMediator::saveObject ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPObjectMediator_c200f88239b8940d9d38cbe04c3e961e} - - -Saves the object - -This saves the object in the database by updating the values in the database with those in the object. - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Object}]the object to be saved \end{description} -\end{Desc} - - -Implements \hyperlink{classcMediatorInterface_a2f40e697f499c64cfd007aa70e3da7e}{cMediatorInterface}. - -The documentation for this class was generated from the following files:\begin{CompactItemize} -\item -database/object.h\item -database/object.cpp\end{CompactItemize} |