diff options
Diffstat (limited to 'doc/latex/classcUPnPMovieMediator.tex')
-rw-r--r-- | doc/latex/classcUPnPMovieMediator.tex | 153 |
1 files changed, 0 insertions, 153 deletions
diff --git a/doc/latex/classcUPnPMovieMediator.tex b/doc/latex/classcUPnPMovieMediator.tex deleted file mode 100644 index 7fe459f..0000000 --- a/doc/latex/classcUPnPMovieMediator.tex +++ /dev/null @@ -1,153 +0,0 @@ -\hypertarget{classcUPnPMovieMediator}{ -\section{cUPnPMovieMediator Class Reference} -\label{classcUPnPMovieMediator}\index{cUPnPMovieMediator@{cUPnPMovieMediator}} -} -{\tt \#include $<$object.h$>$} - -Inheritance diagram for cUPnPMovieMediator:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=400pt]{classcUPnPMovieMediator__inherit__graph} -\end{center} -\end{figure} -Collaboration diagram for cUPnPMovieMediator:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[width=400pt]{classcUPnPMovieMediator__coll__graph} -\end{center} -\end{figure} -\subsection*{Public Member Functions} -\begin{CompactItemize} -\item -\hyperlink{classcUPnPMovieMediator_aa40d0f4054d6b90b2cbb0fe6bd8ac38}{cUPnPMovieMediator} (\hyperlink{classcMediaDatabase}{cMediaDatabase} $\ast$MediaDatabase) -\item -virtual \hyperlink{classcUPnPClassMovie}{cUPnPClassMovie} $\ast$ \hyperlink{classcUPnPMovieMediator_29d40a311b7283cc4fba36860ac8c935}{createObject} (const char $\ast$Title, bool Restricted) -\item -virtual \hyperlink{classcUPnPClassMovie}{cUPnPClassMovie} $\ast$ \hyperlink{classcUPnPMovieMediator_d85b240eb54efd9ab46c440b51c71e83}{getObject} (\hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) -\end{CompactItemize} -\subsection*{Protected Member Functions} -\begin{CompactItemize} -\item -virtual int \hyperlink{classcUPnPMovieMediator_61ab6dcaf2417898428ddf1f635788b7}{objectToDatabase} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) -\item -virtual int \hyperlink{classcUPnPMovieMediator_542135e9c1051b57a8f6f5ecc0c1ede3}{databaseToObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object, \hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) -\end{CompactItemize} - - -\subsection{Detailed Description} -Movie 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{classcUPnPMovieMediator_aa40d0f4054d6b90b2cbb0fe6bd8ac38}{ -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\subsubsection[{cUPnPMovieMediator}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPMovieMediator::cUPnPMovieMediator ({\bf cMediaDatabase} $\ast$ {\em MediaDatabase})}} -\label{classcUPnPMovieMediator_aa40d0f4054d6b90b2cbb0fe6bd8ac38} - - -Constructor of movie mediator - -This creates a new movie mediator with which it is possible to create new instances of Movie objects. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em MediaDatabase}]the media database \end{description} -\end{Desc} - - -\subsection{Member Function Documentation} -\hypertarget{classcUPnPMovieMediator_29d40a311b7283cc4fba36860ac8c935}{ -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!createObject@{createObject}} -\index{createObject@{createObject}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\subsubsection[{createObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassMovie} $\ast$ cUPnPMovieMediator::createObject (const char $\ast$ {\em Title}, \/ bool {\em Restricted})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPMovieMediator_29d40a311b7283cc4fba36860ac8c935} - - -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} - - -Reimplemented from \hyperlink{classcUPnPVideoItemMediator_27e001142c3651c36dfd3b7c450414c0}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPMovieMediator_542135e9c1051b57a8f6f5ecc0c1ede3}{ -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!databaseToObject@{databaseToObject}} -\index{databaseToObject@{databaseToObject}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\subsubsection[{databaseToObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPMovieMediator::databaseToObject ({\bf cUPnPClassObject} $\ast$ {\em Object}, \/ {\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} -\label{classcUPnPMovieMediator_542135e9c1051b57a8f6f5ecc0c1ede3} - - -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 from \hyperlink{classcUPnPVideoItemMediator_3f7ec1937b2b95e3ec5462470971d350}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPMovieMediator_d85b240eb54efd9ab46c440b51c71e83}{ -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!getObject@{getObject}} -\index{getObject@{getObject}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\subsubsection[{getObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassMovie} $\ast$ cUPnPMovieMediator::getObject ({\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPMovieMediator_d85b240eb54efd9ab46c440b51c71e83} - - -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} - - -Reimplemented from \hyperlink{classcUPnPVideoItemMediator_dd8927340a69d247965ef9250adefb21}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPMovieMediator_61ab6dcaf2417898428ddf1f635788b7}{ -\index{cUPnPMovieMediator@{cUPnPMovieMediator}!objectToDatabase@{objectToDatabase}} -\index{objectToDatabase@{objectToDatabase}!cUPnPMovieMediator@{cUPnPMovieMediator}} -\subsubsection[{objectToDatabase}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPMovieMediator::objectToDatabase ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} -\label{classcUPnPMovieMediator_61ab6dcaf2417898428ddf1f635788b7} - - -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 from \hyperlink{classcUPnPVideoItemMediator_984e10738bca46ce38307d5f60e26bd3}{cUPnPVideoItemMediator}. - -The documentation for this class was generated from the following files:\begin{CompactItemize} -\item -database/object.h\item -database/object.cpp\end{CompactItemize} |