Ogre::ArchiveFactory Class Referenceabstract
Core » Resources

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

`#include <OgreArchiveFactory.h>`

Inheritance diagram for Ogre::ArchiveFactory:
[legend]

## Public Member Functions

virtual | ~ArchiveFactory ()
virtual Archive * | createInstance (const String &name, bool readOnly)=0
| Creates a new object. More...
virtual Archive * | createInstance (const String &name)
| 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...
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)

## 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).

Definition at line 59 of file OgreArchiveFactory.h.

## Constructor & Destructor Documentation

## ~ArchiveFactory()

virtual Ogre::ArchiveFactory::~ArchiveFactory | ( |  | ) |

virtual

Definition at line 62 of file OgreArchiveFactory.h.

## 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

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

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

## createInstance() [2/2]

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

virtual

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 >.

Definition at line 71 of file OgreArchiveFactory.h.

References createInstance().

Referenced by createInstance().

## destroyInstance()

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

pure virtual inherited

Destroys an object which was created by this factory.

Parameters

  ptr | Pointer to the object to destroy

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

## getType()

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

pure virtual inherited

Returns the factory type.

Returns
  The factory type.

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

## operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

- OgreArchiveFactory.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.