Ogre::ArchiveFactory Class Reference

Abstract factory class, archive codec plugins can register concrete subclasses of this. More...

#include <OgreArchiveFactory.h>

Inheritance diagram for Ogre::ArchiveFactory:

Public Member Functions
virtual	~ArchiveFactory ()
virtual Archive *	createInstance (const String &name, bool readOnly) OGRE_NODISCARD=0
	Creates a new object. More...
virtual Archive *	createInstance (const String &name) OGRE_NODISCARD
	Creates a new object. More...
virtual void	destroyInstance (Archive *ptr)=0
	Destroys an object which was created by this factory. More...
virtual const String &	getType () const=0
	Returns the factory type. More...

Detailed Description

Abstract factory class, archive codec plugins can register concrete subclasses of this.

Remarks

All access to 'archives' (collections of files, compressed or just folders, maybe even remote) is managed via the abstract Archive class. Plugins are expected to provide the implementation for the actual codec itself, but because a subclass of Archive has to be created for every archive, a factory class is required to create the appropriate subclass.

So archive plugins create a subclass of Archive AND a subclass of ArchiveFactory which creates instances of the Archive subclass. See the 'Zip' and 'FileSystem' plugins for examples. Each Archive and ArchiveFactory subclass pair deal with a single archive type (identified by a string).

Constructor & Destructor Documentation

~ArchiveFactory()

virtual Ogre::ArchiveFactory::~ArchiveFactory ( )

inlinevirtual

References OGRE_NODISCARD.

Member Function Documentation

createInstance() [1/2]

virtual Archive* Ogre::ArchiveFactory::createInstance ( const String &  name, bool  readOnly  )

pure virtual

Creates a new object.

Parameters

name	Name of the object to create
readOnly	whether the Archive is read only

Returns

An object created by the factory. The type of the object depends on the factory.

Implemented in Ogre::APKFileSystemArchiveFactory, Ogre::EmbeddedZipArchiveFactory, Ogre::ZipArchiveFactory, and Ogre::FileSystemArchiveFactory.

Referenced by Ogre::ZipArchiveFactory::~ZipArchiveFactory().

createInstance() [2/2]

virtual Archive* Ogre::ArchiveFactory::createInstance ( const String &  name )

inlinevirtual

Creates a new object.

Parameters

name	Name of the object to create

Returns

An object created by the factory. The type of the object depends on the factory.

Implements Ogre::FactoryObj< Archive >.

References createInstance().

Referenced by createInstance().

getType()

virtual const String& Ogre::FactoryObj< Archive >::getType ( void  ) const

pure virtualinherited

Returns the factory type.

Returns

The factory type.

Implemented in Ogre::APKFileSystemArchiveFactory, Ogre::EmbeddedZipArchiveFactory, Ogre::ZipArchiveFactory, and Ogre::FileSystemArchiveFactory.

destroyInstance()

virtual void Ogre::FactoryObj< Archive >::destroyInstance ( Archive *  ptr )

pure virtualinherited

Destroys an object which was created by this factory.

Parameters

ptr	Pointer to the object to destroy

Implemented in Ogre::APKFileSystemArchiveFactory, Ogre::ZipArchiveFactory, and Ogre::FileSystemArchiveFactory.

---

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

• OgreArchiveFactory.h