This class manages the available ArchiveFactory plugins. More...

#include <OgreArchiveManager.h>

Inheritance diagram for Ogre::ArchiveManager:

Collaboration diagram for Ogre::ArchiveManager:

Public Types
typedef MapIterator< ArchiveMap >	ArchiveMapIterator

Public Member Functions
	ArchiveManager ()
	Default constructor - should never get called by a client app. More...

virtual	~ArchiveManager ()
	Default destructor. More...

void	addArchiveFactory (ArchiveFactory *factory)
	Adds a new ArchiveFactory to the list of available factories. More...

ArchiveMapIterator	getArchiveIterator (void)
	Get an iterator over the Archives in this Manager. More...

Archive *	load (const String &filename, const String &archiveType)
	Opens an archive for file reading. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

void	unload (Archive *arch)
	Unloads an archive. More...

void	unload (const String &filename)
	Unloads an archive by name. More...

Static Public Member Functions
static ArchiveManager &	getSingleton (void)
	Override standard Singleton retrieval. More...

static ArchiveManager *	getSingletonPtr (void)
	Override standard Singleton retrieval. More...

Protected Types
typedef map< String, ArchiveFactory * >::type	ArchiveFactoryMap

typedef map< String, Archive * > ::type	ArchiveMap
	Currently loaded archives. More...

Protected Attributes
ArchiveFactoryMap	mArchFactories
	Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip') More...

ArchiveMap	mArchives

Static Protected Attributes
static ArchiveManager *	ms_Singleton

Detailed Description

This class manages the available ArchiveFactory plugins.

Definition at line 46 of file OgreArchiveManager.h.

Member Typedef Documentation

typedef map<String, ArchiveFactory*>::type Ogre::ArchiveManager::ArchiveFactoryMap

protected

Definition at line 49 of file OgreArchiveManager.h.

typedef map<String, Archive*>::type Ogre::ArchiveManager::ArchiveMap

protected

Currently loaded archives.

Definition at line 53 of file OgreArchiveManager.h.

typedef MapIterator<ArchiveMap> Ogre::ArchiveManager::ArchiveMapIterator

Definition at line 90 of file OgreArchiveManager.h.

Constructor & Destructor Documentation

Ogre::ArchiveManager::ArchiveManager ( )

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

virtual Ogre::ArchiveManager::~ArchiveManager ( )

virtual

Default destructor.

Member Function Documentation

void Ogre::ArchiveManager::addArchiveFactory ( ArchiveFactory * factory )

Adds a new ArchiveFactory to the list of available factories.

Remarks: Plugin developers who add new archive codecs need to call this after defining their ArchiveFactory subclass and Archive subclasses for their archive type.

ArchiveMapIterator Ogre::ArchiveManager::getArchiveIterator ( void )

Get an iterator over the Archives in this Manager.

static ArchiveManager& Ogre::ArchiveManager::getSingleton ( void )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

static ArchiveManager* Ogre::ArchiveManager::getSingletonPtr ( void )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Archive* Ogre::ArchiveManager::load	(	const String &	filename,
		const String &	archiveType
	)

Opens an archive for file reading.

Remarks: The archives are created using class factories within extension libraries.

Parameters

filename	The filename that will be opened
refLibrary	The library that contains the data-handling code

Returns: If the function succeeds, a valid pointer to an Archive object is returned.

: If the function fails, an exception is thrown.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::ArchiveManager::unload ( Archive * arch )

Unloads an archive.

Remarks: You must ensure that this archive is not being used before removing it.

void Ogre::ArchiveManager::unload ( const String & filename )

Unloads an archive by name.

Remarks: You must ensure that this archive is not being used before removing it.

Member Data Documentation

ArchiveFactoryMap Ogre::ArchiveManager::mArchFactories

protected

Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip')

Definition at line 51 of file OgreArchiveManager.h.

ArchiveMap Ogre::ArchiveManager::mArchives

protected

Definition at line 54 of file OgreArchiveManager.h.

ArchiveManager * Ogre::Singleton< ArchiveManager >::ms_Singleton

staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

The documentation for this class was generated from the following file:

OgreArchiveManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation