The factory registry for overview builders. More...

#include <ossimOverviewBuilderFactoryRegistry.h>

Inheritance diagram for ossimOverviewBuilderFactoryRegistry:

Public Member Functions
virtual ossimObject *	createObject (const ossimString &typeName) const

virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const

ossimOverviewBuilderBase *	createBuilder (const ossimString &typeName) const
	Creates a builder from a string. More...

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Method to populate a list of supported types of all factories registered to this registry. More...

Public Member Functions inherited from ossimObjectFactory
virtual	~ossimObjectFactory ()

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >
	ossimFactoryListInterface ()

void	addFactory (ossimOverviewBuilderFactoryBase *factory)
	This is for backward compatability and calls registerFactory for simple adds. More...

bool	isFactoryRegistered (ossimOverviewBuilderFactoryBase *factory) const
	Public access method to determine if a factory is already registered to this list. More...

void	registerFactory (ossimOverviewBuilderFactoryBase *factory, bool pushToFrontFlag=false)
	Will register a factory to the factory list. More...

void	unregisterFactory (ossimOverviewBuilderFactoryBase *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 (ossimOverviewBuilderFactoryBase *factory)
	Inserts the factory to the front of the list. More...

void	registerFactoryBefore (ossimOverviewBuilderFactoryBase factory, ossimOverviewBuilderFactoryBase 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...

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

ossimOverviewBuilderBase *	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 ossimOverviewBuilderFactoryRegistry *	instance ()
	instance method for access to theInstance pointer. More...

Private Member Functions
	ossimOverviewBuilderFactoryRegistry ()
	default constructor hidden from use More...

	ossimOverviewBuilderFactoryRegistry (const ossimOverviewBuilderFactoryRegistry &obj)
	copy constructor hidden from use More...

void	operator= (const ossimOverviewBuilderFactoryRegistry &rhs)
	operator= hidden from use. More...

Static Private Attributes
static ossimOverviewBuilderFactoryRegistry *	m_instance = 0
	The static instance of this class. More...

Additional Inherited Members
Public Types inherited from ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >
typedef std::vector< ossimOverviewBuilderFactoryBase *>	FactoryListType

typedef ossimOverviewBuilderFactoryBase	FactoryType

typedef ossimOverviewBuilderBase	NativeReturnType

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >
bool	findFactory (ossimOverviewBuilderFactoryBase *factory) const
	Utility to find a factory in the list. More...

Protected Attributes inherited from ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >
std::mutex	m_factoryListMutex

FactoryListType	m_factoryList

Detailed Description

The factory registry for overview builders.

Typical usage: std::vector<ossimString> typeList; ossimOverviewBuilderFactoryRegistry::instance()->getTypeNameList(typeList); ossimOverviewBuilderBase* builder = ossimOverviewBuilderFactoryRegistry::instance()->createBuilder( someStringFromTypeList);

Definition at line 33 of file ossimOverviewBuilderFactoryRegistry.h.

Constructor & Destructor Documentation

◆ ossimOverviewBuilderFactoryRegistry() [1/2]

ossimOverviewBuilderFactoryRegistry::ossimOverviewBuilderFactoryRegistry ( )

private

default constructor hidden from use

Definition at line 80 of file ossimOverviewBuilderFactoryRegistry.cpp.

References m_instance.

Referenced by instance().

 {
    m_instance = this;
 }

◆ ossimOverviewBuilderFactoryRegistry() [2/2]

ossimOverviewBuilderFactoryRegistry::ossimOverviewBuilderFactoryRegistry ( const ossimOverviewBuilderFactoryRegistry & obj )

private

copy constructor hidden from use

Definition at line 85 of file ossimOverviewBuilderFactoryRegistry.cpp.

References m_instance.

 {
    m_instance = this;
 }

Member Function Documentation

◆ createBuilder()

ossimOverviewBuilderBase * ossimOverviewBuilderFactoryRegistry::createBuilder ( const ossimString & typeName ) const

Creates a builder from a string.

This should match a string from the getTypeNameList() method.

Returns: Pointer to ossimOverviewBuilderBase or NULL is not found within registered factories.

Definition at line 56 of file ossimOverviewBuilderFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >::m_factoryList.

Referenced by createObject().

 {
    FactoryListType::const_iterator iter = m_factoryList.begin();
    NativeReturnType* result = 0;
    
    while(iter != m_factoryList.end())
    {
       result = (*iter)->createBuilder(typeName);
       if (result)
       {
          break;
       }
       ++iter;
    }
    
    return result;
 }

◆ createObject() [1/2]

ossimObject * ossimOverviewBuilderFactoryRegistry::createObject ( const ossimString & typeName ) const

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 29 of file ossimOverviewBuilderFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >::createObjectFromRegistry().

 {
    return createObjectFromRegistry(typeName);
 }

◆ createObject() [2/2]

ossimObject * ossimOverviewBuilderFactoryRegistry::createObject	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 34 of file ossimOverviewBuilderFactoryRegistry.cpp.

References createBuilder(), ossimString::empty(), ossimKeywordlist::find(), ossimSource::loadState(), ossimRefPtr< T >::release(), and ossimRefPtr< T >::valid().

 {
    ossimRefPtr<NativeReturnType> result = 0;
 
    ossimString type = kwl.find(prefix, "type");
    if(!type.empty())
    {
       result = createBuilder(type);
       if(result.valid())
       {
          if(!result->loadState(kwl, prefix))
          {
             result = 0;
          }
       }
    }
    
    return result.release();
 }

◆ getTypeNameList()

void ossimOverviewBuilderFactoryRegistry::getTypeNameList ( std::vector< ossimString > & typeList ) const

virtual

Method to populate a list of supported types of all factories registered to this registry.

Example:

ossimTiffOverviewNearest ossimTiffOverviewBox

Parameters

typeList List of ossimStrings to add to.

Implements ossimObjectFactory.

Definition at line 75 of file ossimOverviewBuilderFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimOverviewBuilderFactoryBase, ossimOverviewBuilderBase >::getAllTypeNamesFromRegistry().

Referenced by ossimImageUtil::outputOverviewWriterTypes(), and ossimInfo::printOverviewTypes().

 {
    getAllTypeNamesFromRegistry(typeList);
 }

◆ instance()

ossimOverviewBuilderFactoryRegistry * ossimOverviewBuilderFactoryRegistry::instance ( )

static

instance method for access to theInstance pointer.

Returns: Pointer to this class.

Definition at line 19 of file ossimOverviewBuilderFactoryRegistry.cpp.

References ossimObjectFactoryRegistry::instance(), m_instance, ossimOverviewBuilderFactoryRegistry(), and ossimFactoryListInterface< T, NativeType >::registerFactory().

Referenced by ossimInit::initializeDefaultFactories(), ossimSharedLibraryFinalize(), ossimSharedLibraryInitialize(), ossimImageUtil::outputOverviewWriterTypes(), and ossimInfo::printOverviewTypes().

 {
    if ( m_instance == 0 )
    {
       m_instance = new ossimOverviewBuilderFactoryRegistry();
       ossimObjectFactoryRegistry::instance()->registerFactory(m_instance);
    }
    return m_instance;
 }

◆ operator=()

void ossimOverviewBuilderFactoryRegistry::operator= ( const ossimOverviewBuilderFactoryRegistry & rhs )

private

operator= hidden from use.

Definition at line 91 of file ossimOverviewBuilderFactoryRegistry.cpp.

 {
    
 }

Member Data Documentation

◆ m_instance

ossimOverviewBuilderFactoryRegistry * ossimOverviewBuilderFactoryRegistry::m_instance = 0

staticprivate

The static instance of this class.

Definition at line 87 of file ossimOverviewBuilderFactoryRegistry.h.

Referenced by instance(), and ossimOverviewBuilderFactoryRegistry().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimOverviewBuilderFactoryRegistry() [1/2]

◆ ossimOverviewBuilderFactoryRegistry() [2/2]

Member Function Documentation

◆ createBuilder()

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getTypeNameList()

◆ instance()

◆ operator=()

Member Data Documentation

◆ m_instance