ossimCodecFactoryRegistry Class Reference

#include <ossimCodecFactoryRegistry.h>

Inheritance diagram for ossimCodecFactoryRegistry:

Public Member Functions
virtual	~ossimCodecFactoryRegistry ()
virtual ossimCodecBase *	createCodec (const ossimString &type) const
	Will loop through all registered factories trying to allocate a codec for the passed in type. More...
virtual ossimCodecBase *	createCodec (const ossimKeywordlist &kwl, const char *prefix=0) const
	Will loop through all registered factories trying to allocate a codec for the passed in type in the type keyword of the keywordlist. More...
virtual void	getTypeNameList (std::vector< ossimString > &typeNames) const
	Loop through all factories and get a list of supported types. More...
Public Member Functions inherited from ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >
	ossimFactoryListInterface ()
void	addFactory (ossimCodecFactoryInterface *factory)
	This is for backward compatability and calls registerFactory for simple adds. More...
bool	isFactoryRegistered (ossimCodecFactoryInterface *factory) const
	Public access method to determine if a factory is already registered to this list. More...
void	registerFactory (ossimCodecFactoryInterface *factory, bool pushToFrontFlag=false)
	Will register a factory to the factory list. More...
void	unregisterFactory (ossimCodecFactoryInterface *factory)
	Will remove the factory from the registry. More...
void	unregisterFactory (const ossimString &factoryTypeName)
	Will remove the factory from the registry by name. More...
void	unregisterAllFactories ()
	Will remove all factories from the registry. More...
void	registerFactoryToFront (ossimCodecFactoryInterface *factory)
	Inserts the factory to the front of the list. More...
void	registerFactoryBefore (ossimCodecFactoryInterface *factory, ossimCodecFactoryInterface *beforeThisFactory)
	Will insert the factory before the beforeThisFactory. More...
void	getAllTypeNamesFromRegistry (std::vector< ossimString > &typeList) const
	Will add all object types the factories can allocate. More...
ossimObject *	createObjectFromRegistry (const ossimString &typeName) const
	This is the base object return for all objects in the system. More...
ossimObject *	createObjectFromRegistry (const ossimKeywordlist &kwl, const char *prefix=0) const
	This is the base object return for all objects in the system. More...
ossimCodecBase *	createNativeObjectFromRegistry (const ossimString &typeName) const
	This is a helper method that calls the createObject and makes sure that the returned object is of the NativeType base type this registry supports. More...
ossimCodecBase *	createNativeObjectFromRegistry (const ossimKeywordlist &kwl, const char *prefix=0) const
	This is a helper method that calls the createObject and makes sure that the returned object is of the NativeType base type this registry supports. More...

Static Public Member Functions
static ossimCodecFactoryRegistry *	instance ()

Private Member Functions
	ossimCodecFactoryRegistry ()
	hidden from use default constructor More...
	ossimCodecFactoryRegistry (const ossimCodecFactoryRegistry &obj)
	hidden from use copy constructor More...
const ossimCodecFactoryRegistry &	operator= (const ossimCodecFactoryRegistry &rhs)
	hidden from use operator = More...

Static Private Attributes
static ossimCodecFactoryRegistry *	m_instance =0

Additional Inherited Members
Public Types inherited from ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >
typedef std::vector< ossimCodecFactoryInterface *>	FactoryListType
typedef ossimCodecFactoryInterface	FactoryType
typedef ossimCodecBase	NativeReturnType
Protected Member Functions inherited from ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >
bool	findFactory (ossimCodecFactoryInterface *factory) const
	Utility to find a factory in the list. More...
Protected Attributes inherited from ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >
std::mutex	m_factoryListMutex
FactoryListType	m_factoryList

Detailed Description

Definition at line 7 of file ossimCodecFactoryRegistry.h.

Constructor & Destructor Documentation

~ossimCodecFactoryRegistry()

ossimCodecFactoryRegistry::~ossimCodecFactoryRegistry ( )

virtual

Definition at line 35 of file ossimCodecFactoryRegistry.cpp.

References m_instance.

{
   m_instance = 0;
}

ossimCodecFactoryRegistry() [1/2]

ossimCodecFactoryRegistry::ossimCodecFactoryRegistry ( )

private

hidden from use default constructor

Definition at line 7 of file ossimCodecFactoryRegistry.cpp.

References m_instance.

Referenced by instance().

{
   m_instance = this;
}

ossimCodecFactoryRegistry() [2/2]

ossimCodecFactoryRegistry::ossimCodecFactoryRegistry ( const ossimCodecFactoryRegistry &  obj )

private

hidden from use copy constructor

Definition at line 13 of file ossimCodecFactoryRegistry.cpp.

References m_instance.

{
   m_instance = this;
}

Member Function Documentation

createCodec() [1/2]

ossimCodecBase * ossimCodecFactoryRegistry::createCodec ( const ossimString &  type ) const

virtual

Will loop through all registered factories trying to allocate a codec for the passed in type.

Parameters

in	type. Type of Codec to allocate.

Returns

ossimCodecBase. Newly allocated Codec

Definition at line 41 of file ossimCodecFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >::createNativeObjectFromRegistry().

Referenced by ossimNitfCodecFactory::createCodec(), and ossimGpkgWriter::initializeCodec().

{
   return createNativeObjectFromRegistry(type);
}

createCodec() [2/2]

ossimCodecBase * ossimCodecFactoryRegistry::createCodec ( const ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Will loop through all registered factories trying to allocate a codec for the passed in type in the type keyword of the keywordlist.

Parameters

in	kwl. State infromation to load when allocating the codec
in	prefix. prefix value for all keys

Returns

ossimCodecBase. Newly allocated codec

Definition at line 46 of file ossimCodecFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >::createNativeObjectFromRegistry().

{
   return createNativeObjectFromRegistry(kwl, prefix);
}

getTypeNameList()

void ossimCodecFactoryRegistry::getTypeNameList ( std::vector< ossimString > &  typeNames ) const

virtual

Loop through all factories and get a list of supported types.

Parameters

out	typeNames. The resulting typename list. Values will be appended.

Definition at line 52 of file ossimCodecFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimCodecFactoryInterface, ossimCodecBase >::getAllTypeNamesFromRegistry().

{
   getAllTypeNamesFromRegistry(typeNames);
}

instance()

ossimCodecFactoryRegistry * ossimCodecFactoryRegistry::instance ( )

static

Definition at line 24 of file ossimCodecFactoryRegistry.cpp.

References ossimCodecFactory::instance(), m_instance, ossimCodecFactoryRegistry(), and ossimFactoryListInterface< T, NativeType >::registerFactory().

Referenced by ossimNitfCodecFactory::createCodec(), ossimGpkgWriter::initializeCodec(), ossimInit::initializeDefaultFactories(), ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

{
   if(!m_instance)
   {
      m_instance = new ossimCodecFactoryRegistry();
      m_instance->registerFactory(ossimCodecFactory::instance());
   }
   
   return m_instance;
}

operator=()

const ossimCodecFactoryRegistry & ossimCodecFactoryRegistry::operator= ( const ossimCodecFactoryRegistry &  rhs )

private

hidden from use operator =

Definition at line 19 of file ossimCodecFactoryRegistry.cpp.

{
   return *this;
}

Member Data Documentation

m_instance

ossimCodecFactoryRegistry * ossimCodecFactoryRegistry::m_instance =0

staticprivate

Definition at line 53 of file ossimCodecFactoryRegistry.h.

Referenced by instance(), ossimCodecFactoryRegistry(), and ~ossimCodecFactoryRegistry().

---

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

• ossimCodecFactoryRegistry.h
• ossimCodecFactoryRegistry.cpp