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


This class manages the available \mbox{\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}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \mbox{\hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}}$<$ Archive\+Map $>$ \mbox{\hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Archive\+Map\+Iterator}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\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 \mbox{\hyperlink{class_ogre_1_1_archive_manager_a0abcd0bcbab592304b00023b87d2b48e}{$\sim$\+Archive\+Manager}} ()
\begin{DoxyCompactList}\small\item\em Default destructor. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_archive_manager_ab6c255acb890a2d21ae1d3379a512730}{add\+Archive\+Factory}} (\mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} $\ast$factory)
\begin{DoxyCompactList}\small\item\em Adds a new \mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} to the list of available factories. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_archive_manager_a912729e3f6383f3883ffd361bca0464f}{Archive\+Map\+Iterator}} \mbox{\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 
\mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}{load}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&filename, const \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_archive_manager_afae10919b8d8d0884fe413d56a683006}{unload}} (\mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$arch)
\begin{DoxyCompactList}\small\item\em Unloads an archive. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_archive_manager_a05baddedf360653448d436c33dbf0de3}{unload}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&filename)
\begin{DoxyCompactList}\small\item\em Unloads an archive by name. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager}} \& \mbox{\hyperlink{class_ogre_1_1_archive_manager_ad5b5f92045294d97c3aecddaba89de31}{get\+Singleton}} (void)
\begin{DoxyCompactList}\small\item\em Get the singleton instance. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{class_ogre_1_1_archive_manager}{Archive\+Manager}} $\ast$ \mbox{\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}


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

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



\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_a4af6cf74f6bc68dfbc25032799261c3a}\label{class_ogre_1_1_archive_manager_a4af6cf74f6bc68dfbc25032799261c3a}} 
\index{Ogre::ArchiveManager@{Ogre::ArchiveManager}!ArchiveManager@{ArchiveManager}}
\index{ArchiveManager@{ArchiveManager}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{ArchiveManager()}{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::ArchiveManager@{Ogre::ArchiveManager}!````~ArchiveManager@{$\sim$ArchiveManager}}
\index{````~ArchiveManager@{$\sim$ArchiveManager}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{$\sim$ArchiveManager()}{~ArchiveManager()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Archive\+Manager\+::$\sim$\+Archive\+Manager (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Default destructor. 



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}\label{class_ogre_1_1_archive_manager_add423fd0a10d6d424cb302b996bfc63c}} 
\index{Ogre::ArchiveManager@{Ogre::ArchiveManager}!load@{load}}
\index{load@{load}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{load()}{load()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}}$\ast$ Ogre\+::\+Archive\+Manager\+::load (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{filename,  }\item[{const \mbox{\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 \mbox{\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 \mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!unload@{unload}}
\index{unload@{unload}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{unload()}{unload()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::unload (\begin{DoxyParamCaption}\item[{\mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!unload@{unload}}
\index{unload@{unload}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{unload()}{unload()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::unload (\begin{DoxyParamCaption}\item[{const \mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!getArchiveIterator@{getArchiveIterator}}
\index{getArchiveIterator@{getArchiveIterator}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{getArchiveIterator()}{getArchiveIterator()}}
{\footnotesize\ttfamily \mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!addArchiveFactory@{addArchiveFactory}}
\index{addArchiveFactory@{addArchiveFactory}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{addArchiveFactory()}{addArchiveFactory()}}
{\footnotesize\ttfamily void Ogre\+::\+Archive\+Manager\+::add\+Archive\+Factory (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} $\ast$}]{factory }\end{DoxyParamCaption})}



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

\begin{DoxyRemark}{Remarks}
\mbox{\hyperlink{class_ogre_1_1_plugin}{Plugin}} developers who add new archive codecs need to call this after defining their \mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} subclass and \mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!getSingleton@{getSingleton}}
\index{getSingleton@{getSingleton}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{getSingleton()}{getSingleton()}}
{\footnotesize\ttfamily static \mbox{\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::ArchiveManager@{Ogre::ArchiveManager}!getSingletonPtr@{getSingletonPtr}}
\index{getSingletonPtr@{getSingletonPtr}!Ogre::ArchiveManager@{Ogre::ArchiveManager}}
\doxysubsubsection{\texorpdfstring{getSingletonPtr()}{getSingletonPtr()}}
{\footnotesize\ttfamily static \mbox{\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 
\mbox{\hyperlink{_ogre_archive_manager_8h}{Ogre\+Archive\+Manager.\+h}}\end{DoxyCompactItemize}
