\hypertarget{class_ogre_1_1_archive_manager}{}\section{Ogre\+:\+:Archive\+Manager Class Reference}
\label{class_ogre_1_1_archive_manager}\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}


This class manages the available \hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} plugins.  




{\ttfamily \#include $<$Ogre\+Archive\+Manager.\+h$>$}



Inheritance diagram for Ogre\+:\+:Archive\+Manager\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=316pt]{class_ogre_1_1_archive_manager__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$ Archive\+Map $>$ \hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Archive\+Map\+Iterator}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_archive_manager_a4af6cf74f6bc68dfbc25032799261c3a}{Archive\+Manager} ()
\begin{DoxyCompactList}\small\item\em Default constructor -\/ should never get called by a client app. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_archive_manager_a0abcd0bcbab592304b00023b87d2b48e}{$\sim$\+Archive\+Manager} ()
\begin{DoxyCompactList}\small\item\em Default destructor. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_archive_manager_ab6c255acb890a2d21ae1d3379a512730}{add\+Archive\+Factory} (\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} $\ast$factory)
\begin{DoxyCompactList}\small\item\em Adds a new \hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} to the list of available factories. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Archive\+Map\+Iterator} \hyperlink{class_ogre_1_1_archive_manager_abbd80b38555563f8c2b58956e04943cb}{get\+Archive\+Iterator} (void)
\begin{DoxyCompactList}\small\item\em Get an iterator over the Archives in this Manager. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_archive}{Archive} $\ast$ \hyperlink{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}{load} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&filename, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&archive\+Type, bool read\+Only)
\begin{DoxyCompactList}\small\item\em Opens an archive for file reading. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_archive_manager_afae10919b8d8d0884fe413d56a683006}{unload} (\hyperlink{class_ogre_1_1_archive}{Archive} $\ast$arch)
\begin{DoxyCompactList}\small\item\em Unloads an archive. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_archive_manager_a05baddedf360653448d436c33dbf0de3}{unload} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&filename)
\begin{DoxyCompactList}\small\item\em Unloads an archive by name. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager} \& \hyperlink{class_ogre_1_1_archive_manager_ad5b5f92045294d97c3aecddaba89de31}{get\+Singleton} (void)
\begin{DoxyCompactList}\small\item\em Get the singleton instance. \end{DoxyCompactList}\item 
static \hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager} $\ast$ \hyperlink{class_ogre_1_1_archive_manager_a460a08ab422a879e91dd154ee33c2aac}{get\+Singleton\+Ptr} (void)
\begin{DoxyCompactList}\small\item\em Get the singleton instance. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class manages the available \hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} plugins. 

\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}\label{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!Archive\+Map\+Iterator@{Archive\+Map\+Iterator}}
\index{Archive\+Map\+Iterator@{Archive\+Map\+Iterator}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{Archive\+Map\+Iterator}{ArchiveMapIterator}}
{\footnotesize\ttfamily typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$Archive\+Map$>$ \hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Ogre\+::\+Archive\+Manager\+::\+Archive\+Map\+Iterator}}



\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a4af6cf74f6bc68dfbc25032799261c3a}\label{class_ogre_1_1_archive_manager_a4af6cf74f6bc68dfbc25032799261c3a}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!Archive\+Manager@{Archive\+Manager}}
\index{Archive\+Manager@{Archive\+Manager}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{Archive\+Manager()}{ArchiveManager()}}
{\footnotesize\ttfamily Ogre\+::\+Archive\+Manager\+::\+Archive\+Manager (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Default constructor -\/ should never get called by a client app. 

\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a0abcd0bcbab592304b00023b87d2b48e}\label{class_ogre_1_1_archive_manager_a0abcd0bcbab592304b00023b87d2b48e}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!````~Archive\+Manager@{$\sim$\+Archive\+Manager}}
\index{````~Archive\+Manager@{$\sim$\+Archive\+Manager}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{$\sim$\+Archive\+Manager()}{~ArchiveManager()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Archive\+Manager\+::$\sim$\+Archive\+Manager (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Default destructor. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}\label{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!load@{load}}
\index{load@{load}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{load()}{load()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_archive}{Archive}$\ast$ Ogre\+::\+Archive\+Manager\+::load (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{filename,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{archive\+Type,  }\item[{bool}]{read\+Only }\end{DoxyParamCaption})}



Opens an archive for file reading. 

\begin{DoxyRemark}{Remarks}
The archives are created using class factories within extension libraries. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em filename} & The filename that will be opened \\
\hline
{\em archive\+Type} & The type of archive that this is. For example\+: \char`\"{}\+Zip\char`\"{}. \\
\hline
{\em read\+Only} & Whether the \hyperlink{class_ogre_1_1_archive}{Archive} is read only \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
If the function succeeds, a valid pointer to an \hyperlink{class_ogre_1_1_archive}{Archive} object is returned. 
\end{DoxyReturn}
\begin{DoxyParagraph}{}
If the function fails, an exception is thrown. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_afae10919b8d8d0884fe413d56a683006}\label{class_ogre_1_1_archive_manager_afae10919b8d8d0884fe413d56a683006}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!unload@{unload}}
\index{unload@{unload}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{unload()}{unload()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::unload (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_archive}{Archive} $\ast$}]{arch }\end{DoxyParamCaption})}



Unloads an archive. 

\begin{DoxyRemark}{Remarks}
You must ensure that this archive is not being used before removing it. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a05baddedf360653448d436c33dbf0de3}\label{class_ogre_1_1_archive_manager_a05baddedf360653448d436c33dbf0de3}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!unload@{unload}}
\index{unload@{unload}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{unload()}{unload()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::unload (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{filename }\end{DoxyParamCaption})}



Unloads an archive by name. 

\begin{DoxyRemark}{Remarks}
You must ensure that this archive is not being used before removing it. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_abbd80b38555563f8c2b58956e04943cb}\label{class_ogre_1_1_archive_manager_abbd80b38555563f8c2b58956e04943cb}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!get\+Archive\+Iterator@{get\+Archive\+Iterator}}
\index{get\+Archive\+Iterator@{get\+Archive\+Iterator}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{get\+Archive\+Iterator()}{getArchiveIterator()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Archive\+Map\+Iterator} Ogre\+::\+Archive\+Manager\+::get\+Archive\+Iterator (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Get an iterator over the Archives in this Manager. 

\mbox{\Hypertarget{class_ogre_1_1_archive_manager_ab6c255acb890a2d21ae1d3379a512730}\label{class_ogre_1_1_archive_manager_ab6c255acb890a2d21ae1d3379a512730}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!add\+Archive\+Factory@{add\+Archive\+Factory}}
\index{add\+Archive\+Factory@{add\+Archive\+Factory}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{add\+Archive\+Factory()}{addArchiveFactory()}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::add\+Archive\+Factory (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} $\ast$}]{factory }\end{DoxyParamCaption})}



Adds a new \hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} to the list of available factories. 

\begin{DoxyRemark}{Remarks}
\hyperlink{class_ogre_1_1_plugin}{Plugin} developers who add new archive codecs need to call this after defining their \hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory} subclass and \hyperlink{class_ogre_1_1_archive}{Archive} subclasses for their archive type. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_ad5b5f92045294d97c3aecddaba89de31}\label{class_ogre_1_1_archive_manager_ad5b5f92045294d97c3aecddaba89de31}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!get\+Singleton@{get\+Singleton}}
\index{get\+Singleton@{get\+Singleton}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{get\+Singleton()}{getSingleton()}}
{\footnotesize\ttfamily static \hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager}\& Ogre\+::\+Archive\+Manager\+::get\+Singleton (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get the singleton instance. 

\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a460a08ab422a879e91dd154ee33c2aac}\label{class_ogre_1_1_archive_manager_a460a08ab422a879e91dd154ee33c2aac}} 
\index{Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}!get\+Singleton\+Ptr@{get\+Singleton\+Ptr}}
\index{get\+Singleton\+Ptr@{get\+Singleton\+Ptr}!Ogre\+::\+Archive\+Manager@{Ogre\+::\+Archive\+Manager}}
\subsubsection{\texorpdfstring{get\+Singleton\+Ptr()}{getSingletonPtr()}}
{\footnotesize\ttfamily static \hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager}$\ast$ Ogre\+::\+Archive\+Manager\+::get\+Singleton\+Ptr (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get the singleton instance. 



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_archive_manager_8h}{Ogre\+Archive\+Manager.\+h}\end{DoxyCompactItemize}
