diff options
author | Denis Loh <denis.loh@gmail.com> | 2010-01-25 12:10:01 +0100 |
---|---|---|
committer | Denis Loh <denis.loh@gmail.com> | 2010-01-25 12:10:01 +0100 |
commit | 724cb5e3783311f6b8c808852dbe2de59f2399b0 (patch) | |
tree | be1f2d617b4a3e2e156b7a2d6ba9ee335cde63cf /doc/latex/classcUPnPContainerMediator.tex | |
parent | 0152f33daffe3fe943d6a134409d02df7ecaa982 (diff) | |
download | vdr-plugin-upnp-724cb5e3783311f6b8c808852dbe2de59f2399b0.tar.gz vdr-plugin-upnp-724cb5e3783311f6b8c808852dbe2de59f2399b0.tar.bz2 |
Fixed small bug which leads to an empty TV folder
Diffstat (limited to 'doc/latex/classcUPnPContainerMediator.tex')
-rw-r--r-- | doc/latex/classcUPnPContainerMediator.tex | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/doc/latex/classcUPnPContainerMediator.tex b/doc/latex/classcUPnPContainerMediator.tex new file mode 100644 index 0000000..04800d4 --- /dev/null +++ b/doc/latex/classcUPnPContainerMediator.tex @@ -0,0 +1,153 @@ +\hypertarget{classcUPnPContainerMediator}{ +\section{cUPnPContainerMediator Class Reference} +\label{classcUPnPContainerMediator}\index{cUPnPContainerMediator@{cUPnPContainerMediator}} +} +{\tt \#include $<$object.h$>$} + +Inheritance diagram for cUPnPContainerMediator:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=400pt]{classcUPnPContainerMediator__inherit__graph} +\end{center} +\end{figure} +Collaboration diagram for cUPnPContainerMediator:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[width=400pt]{classcUPnPContainerMediator__coll__graph} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +\hyperlink{classcUPnPContainerMediator_e6fce4835ea40a77b401a093f65b5822}{cUPnPContainerMediator} (\hyperlink{classcMediaDatabase}{cMediaDatabase} $\ast$MediaDatabase) +\item +virtual \hyperlink{classcUPnPClassContainer}{cUPnPClassContainer} $\ast$ \hyperlink{classcUPnPContainerMediator_751177c725da94b1b91f6cda4645844d}{createObject} (const char $\ast$Title, bool Restricted) +\item +virtual \hyperlink{classcUPnPClassContainer}{cUPnPClassContainer} $\ast$ \hyperlink{classcUPnPContainerMediator_78b71f96fb4289dc78f897d6282078d6}{getObject} (\hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) +\end{CompactItemize} +\subsection*{Protected Member Functions} +\begin{CompactItemize} +\item +virtual int \hyperlink{classcUPnPContainerMediator_1caa4625fca42940ba36999a71ac49ec}{objectToDatabase} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object) +\item +virtual int \hyperlink{classcUPnPContainerMediator_79f483b48f596047ed9549f0b036f35b}{databaseToObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object, \hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID) +\end{CompactItemize} + + +\subsection{Detailed Description} +Container 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{classcUPnPContainerMediator_e6fce4835ea40a77b401a093f65b5822}{ +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\subsubsection[{cUPnPContainerMediator}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPContainerMediator::cUPnPContainerMediator ({\bf cMediaDatabase} $\ast$ {\em MediaDatabase})}} +\label{classcUPnPContainerMediator_e6fce4835ea40a77b401a093f65b5822} + + +Constructor of container mediator + +This creates a new container mediator with which it is possible to create new instances of Container objects. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em MediaDatabase}]the media database \end{description} +\end{Desc} + + +\subsection{Member Function Documentation} +\hypertarget{classcUPnPContainerMediator_751177c725da94b1b91f6cda4645844d}{ +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!createObject@{createObject}} +\index{createObject@{createObject}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\subsubsection[{createObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassContainer} $\ast$ cUPnPContainerMediator::createObject (const char $\ast$ {\em Title}, \/ bool {\em Restricted})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPContainerMediator_751177c725da94b1b91f6cda4645844d} + + +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{classcUPnPObjectMediator_bfbca3f1cbadacee2b21306364750f26}{cUPnPObjectMediator}.\hypertarget{classcUPnPContainerMediator_79f483b48f596047ed9549f0b036f35b}{ +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!databaseToObject@{databaseToObject}} +\index{databaseToObject@{databaseToObject}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\subsubsection[{databaseToObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPContainerMediator::databaseToObject ({\bf cUPnPClassObject} $\ast$ {\em Object}, \/ {\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} +\label{classcUPnPContainerMediator_79f483b48f596047ed9549f0b036f35b} + + +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{classcUPnPObjectMediator_07a6a1d2694fb2f4573bd50374406b24}{cUPnPObjectMediator}.\hypertarget{classcUPnPContainerMediator_78b71f96fb4289dc78f897d6282078d6}{ +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!getObject@{getObject}} +\index{getObject@{getObject}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\subsubsection[{getObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassContainer} $\ast$ cUPnPContainerMediator::getObject ({\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPContainerMediator_78b71f96fb4289dc78f897d6282078d6} + + +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{classcUPnPObjectMediator_5b4fff612476fb51690919f9c59899a5}{cUPnPObjectMediator}.\hypertarget{classcUPnPContainerMediator_1caa4625fca42940ba36999a71ac49ec}{ +\index{cUPnPContainerMediator@{cUPnPContainerMediator}!objectToDatabase@{objectToDatabase}} +\index{objectToDatabase@{objectToDatabase}!cUPnPContainerMediator@{cUPnPContainerMediator}} +\subsubsection[{objectToDatabase}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPContainerMediator::objectToDatabase ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}} +\label{classcUPnPContainerMediator_1caa4625fca42940ba36999a71ac49ec} + + +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{classcUPnPObjectMediator_c44c010895f92adc63af2a2d34cf34c8}{cUPnPObjectMediator}. + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +database/object.h\item +database/object.cpp\end{CompactItemize} |