Murl::Util::IFactory Interface Referenceabstract

The factory used to create utility objects Use the Util::IFactoryRegistry base interface for managing registered classes. More...

#include "murl_util_i_factory.h"

Inheritance diagram for Murl::Util::IFactory:

Public Member Functions

virtual Bool Init ()=0
 Initialize the factory. More...
 
virtual Bool DeInit ()=0
 Deinitialize the factory. More...
 
virtual IImageDecoder * GetImageDecoder (const String &className)=0
 Get an image decoder using a given class name. More...
 
virtual IImageDecoder * GetImageDecoder (const IImageDecoder::ClassInfo &classInfo)=0
 Get an image decoder using a given class info. More...
 
virtual IImageEncoder * GetImageEncoder (const String &className)=0
 Get an image encoder using a given class name. More...
 
virtual IImageEncoder * GetImageEncoder (const IImageEncoder::ClassInfo &classInfo)=0
 Get an image encoder using a given class info. More...
 
virtual IImageDecompressor * GetImageDecompressor (const String &className)=0
 Get an image decompressor using a given class name. More...
 
virtual IImageDecompressor * GetImageDecompressor (const IImageDecompressor::ClassInfo &classInfo)=0
 Get an image decompressor using a given class info. More...
 
virtual IImageDecompressor * GetImageDecompressor (IEnums::PixelFormat pixelFormat)=0
 Get an image decompressor for a given compressed pixel format. More...
 
virtual IImageCompressor * GetImageCompressor (const String &className)=0
 Get an image compressor using a given class name. More...
 
virtual IImageCompressor * GetImageCompressor (const IImageCompressor::ClassInfo &classInfo)=0
 Get an image compressor using a given class info. More...
 
virtual IImageCompressor * GetImageCompressor (IEnums::PixelFormat pixelFormat)=0
 Get an image compressor for a given compressed pixel format. More...
 
- Public Member Functions inherited from Murl::Util::IFactoryRegistry
virtual Bool RegisterImageDecoderClass (const IImageDecoder::ClassInfo &classInfo)=0
 Register an image decoder class. More...
 
virtual Bool UnregisterImageDecoderClass (const IImageDecoder::ClassInfo &classInfo)=0
 Unregister a previously registered image decoder class. More...
 
virtual SInt32 GetRegisteredImageDecoderClassInfoIndex (const IImageDecoder::ClassInfo &classInfo) const =0
 Query the index of a registered image decoder class, by its ClassInfo structure. More...
 
virtual SInt32 GetRegisteredImageDecoderClassInfoIndex (const String &className) const =0
 Query the index of a registered image decoder class, by its class name. More...
 
virtual UInt32 GetNumberOfRegisteredImageDecoderClassInfos () const =0
 Get the total number of registered image decoder classes. More...
 
virtual const IImageDecoder::ClassInfo * GetRegisteredImageDecoderClassInfo (UInt32 index) const =0
 Get the ClassInfo structure of a registered image decoder class. More...
 
virtual Bool RegisterImageEncoderClass (const IImageEncoder::ClassInfo &classInfo)=0
 Register an image encoder class. More...
 
virtual Bool UnregisterImageEncoderClass (const IImageEncoder::ClassInfo &classInfo)=0
 Unregister a previously registered image encoder class. More...
 
virtual SInt32 GetRegisteredImageEncoderClassInfoIndex (const IImageEncoder::ClassInfo &classInfo) const =0
 Query the index of a registered image encoder class, by its ClassInfo structure. More...
 
virtual SInt32 GetRegisteredImageEncoderClassInfoIndex (const String &className) const =0
 Query the index of a registered image encoder class, by its class name. More...
 
virtual UInt32 GetNumberOfRegisteredImageEncoderClassInfos () const =0
 Get the total number of registered image encoder classes. More...
 
virtual const IImageEncoder::ClassInfo * GetRegisteredImageEncoderClassInfo (UInt32 index) const =0
 Get the ClassInfo structure of a registered image encoder class. More...
 
virtual Bool RegisterImageDecompressorClass (const IImageDecompressor::ClassInfo &classInfo)=0
 Register an image decompressor class. More...
 
virtual Bool UnregisterImageDecompressorClass (const IImageDecompressor::ClassInfo &classInfo)=0
 Unregister a previously registered image decompressor class. More...
 
virtual SInt32 GetRegisteredImageDecompressorClassInfoIndex (const IImageDecompressor::ClassInfo &classInfo) const =0
 Query the index of a registered image decompressor class, by its ClassInfo structure. More...
 
virtual SInt32 GetRegisteredImageDecompressorClassInfoIndex (const String &className) const =0
 Query the index of a registered image decompressor class, by its class name. More...
 
virtual UInt32 GetNumberOfRegisteredImageDecompressorClassInfos () const =0
 Get the total number of registered image decompressor classes. More...
 
virtual const IImageDecompressor::ClassInfo * GetRegisteredImageDecompressorClassInfo (UInt32 index) const =0
 Get the ClassInfo structure of a registered image decompressor class. More...
 
virtual Bool RegisterImageCompressorClass (const IImageCompressor::ClassInfo &classInfo)=0
 Register an image compressor class. More...
 
virtual Bool UnregisterImageCompressorClass (const IImageCompressor::ClassInfo &classInfo)=0
 Unregister a previously registered image compressor class. More...
 
virtual SInt32 GetRegisteredImageCompressorClassInfoIndex (const IImageCompressor::ClassInfo &classInfo) const =0
 Query the index of a registered image compressor class, by its ClassInfo structure. More...
 
virtual SInt32 GetRegisteredImageCompressorClassInfoIndex (const String &className) const =0
 Query the index of a registered image compressor class, by its class name. More...
 
virtual UInt32 GetNumberOfRegisteredImageCompressorClassInfos () const =0
 Get the total number of registered image compressor classes. More...
 
virtual const IImageCompressor::ClassInfo * GetRegisteredImageCompressorClassInfo (UInt32 index) const =0
 Get the ClassInfo structure of a registered image compressor class. More...
 

Detailed Description

The factory used to create utility objects Use the Util::IFactoryRegistry base interface for managing registered classes.

Member Function Documentation

◆ Init()

virtual Bool Murl::Util::IFactory::Init ( )
pure virtual

Initialize the factory.

Returns
true if successful.

◆ DeInit()

virtual Bool Murl::Util::IFactory::DeInit ( )
pure virtual

Deinitialize the factory.

Returns
true if successful.

◆ GetImageDecoder() [1/2]

virtual IImageDecoder* Murl::Util::IFactory::GetImageDecoder ( const String className)
pure virtual

Get an image decoder using a given class name.

Parameters
classNameThe class name of a registered decoder.
Returns
The registered decoder, or null if not present.

◆ GetImageDecoder() [2/2]

virtual IImageDecoder* Murl::Util::IFactory::GetImageDecoder ( const IImageDecoder::ClassInfo &  classInfo)
pure virtual

Get an image decoder using a given class info.

Parameters
classInfoThe ClassInfo structure of a registered decoder.
Returns
The registered decoder, or null if not present.

◆ GetImageEncoder() [1/2]

virtual IImageEncoder* Murl::Util::IFactory::GetImageEncoder ( const String className)
pure virtual

Get an image encoder using a given class name.

Parameters
classNameThe class name of a registered encoder.
Returns
The registered encoder, or null if not present.

◆ GetImageEncoder() [2/2]

virtual IImageEncoder* Murl::Util::IFactory::GetImageEncoder ( const IImageEncoder::ClassInfo &  classInfo)
pure virtual

Get an image encoder using a given class info.

Parameters
classInfoThe ClassInfo structure of a registered encoder.
Returns
The registered encoder, or null if not present.

◆ GetImageDecompressor() [1/3]

virtual IImageDecompressor* Murl::Util::IFactory::GetImageDecompressor ( const String className)
pure virtual

Get an image decompressor using a given class name.

Parameters
classNameThe class name of a registered decompressor.
Returns
The registered decompressor, or null if not present.

◆ GetImageDecompressor() [2/3]

virtual IImageDecompressor* Murl::Util::IFactory::GetImageDecompressor ( const IImageDecompressor::ClassInfo &  classInfo)
pure virtual

Get an image decompressor using a given class info.

Parameters
classInfoThe ClassInfo structure of a registered decompressor.
Returns
The registered decompressor, or null if not present.

◆ GetImageDecompressor() [3/3]

virtual IImageDecompressor* Murl::Util::IFactory::GetImageDecompressor ( IEnums::PixelFormat  pixelFormat)
pure virtual

Get an image decompressor for a given compressed pixel format.

Parameters
pixelFormatThe format for which to get a decompressor.
Returns
The registered decompressor, or null if not present.

◆ GetImageCompressor() [1/3]

virtual IImageCompressor* Murl::Util::IFactory::GetImageCompressor ( const String className)
pure virtual

Get an image compressor using a given class name.

Parameters
classNameThe class name of a registered compressor.
Returns
The registered compressor, or null if not present.

◆ GetImageCompressor() [2/3]

virtual IImageCompressor* Murl::Util::IFactory::GetImageCompressor ( const IImageCompressor::ClassInfo &  classInfo)
pure virtual

Get an image compressor using a given class info.

Parameters
classInfoThe ClassInfo structure of a registered compressor.
Returns
The registered compressor, or null if not present.

◆ GetImageCompressor() [3/3]

virtual IImageCompressor* Murl::Util::IFactory::GetImageCompressor ( IEnums::PixelFormat  pixelFormat)
pure virtual

Get an image compressor for a given compressed pixel format.

Parameters
pixelFormatThe format for which to get a compressor.
Returns
The registered compressor, or null if not present.

The documentation for this interface was generated from the following file:
  • murl_util_i_factory.h


Copyright © 2011-2024 Spraylight GmbH.