ossimImageWriterFactoryRegistry Class Reference

#include <ossimImageWriterFactoryRegistry.h>

Inheritance diagram for ossimImageWriterFactoryRegistry:

Public Member Functions
ossimImageFileWriter *	createWriter (const ossimFilename &filename) const
ossimImageFileWriter *	createWriterFromExtension (const ossimString &fileExtension) const
ossimImageFileWriter *	createWriter (const ossimKeywordlist &kwl, const char *prefix=0) const
ossimImageFileWriter *	createWriter (const ossimString &typeName) const
ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
ossimObject *	createObject (const ossimString &typeName) const
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	getTypeNameList. More...
virtual void	getImageTypeList (std::vector< ossimString > &imageTypeList) const
	getImageTypeList. More...
virtual void	getImageFileWritersBySuffix (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &ext) const
virtual void	getImageFileWritersByMimeType (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &mimeType) const
std::ostream &	printImageTypeList (std::ostream &out) const
	Prints list of writers from getImageTypeList. More...
std::ostream &	printWriterProps (std::ostream &out) const
	Prints list of writers from getImageTypeList. 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< ossimImageWriterFactoryBase, ossimImageFileWriter >
	ossimFactoryListInterface ()
void	addFactory (ossimImageWriterFactoryBase *factory)
	This is for backward compatability and calls registerFactory for simple adds. More...
bool	isFactoryRegistered (ossimImageWriterFactoryBase *factory) const
	Public access method to determine if a factory is already registered to this list. More...
void	registerFactory (ossimImageWriterFactoryBase *factory, bool pushToFrontFlag=false)
	Will register a factory to the factory list. More...
void	unregisterFactory (ossimImageWriterFactoryBase *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 (ossimImageWriterFactoryBase *factory)
	Inserts the factory to the front of the list. More...
void	registerFactoryBefore (ossimImageWriterFactoryBase *factory, ossimImageWriterFactoryBase *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...
ossimImageFileWriter *	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...
ossimImageFileWriter *	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 ossimImageWriterFactoryRegistry *	instance ()

Protected Member Functions
	ossimImageWriterFactoryRegistry ()
	ossimImageWriterFactoryRegistry (const ossimImageWriterFactoryRegistry &)
void	operator= (const ossimImageWriterFactoryRegistry &)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >
bool	findFactory (ossimImageWriterFactoryBase *factory) const
	Utility to find a factory in the list. More...

Additional Inherited Members
Public Types inherited from ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >
typedef std::vector< ossimImageWriterFactoryBase *>	FactoryListType
typedef ossimImageWriterFactoryBase	FactoryType
typedef ossimImageFileWriter	NativeReturnType
Protected Attributes inherited from ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >
std::mutex	m_factoryListMutex
FactoryListType	m_factoryList

Detailed Description

Definition at line 24 of file ossimImageWriterFactoryRegistry.h.

Constructor & Destructor Documentation

ossimImageWriterFactoryRegistry() [1/2]

ossimImageWriterFactoryRegistry::ossimImageWriterFactoryRegistry ( )

protected

Definition at line 28 of file ossimImageWriterFactoryRegistry.cpp.

{
}

ossimImageWriterFactoryRegistry() [2/2]

ossimImageWriterFactoryRegistry::ossimImageWriterFactoryRegistry ( const ossimImageWriterFactoryRegistry &  )

protected

Definition at line 309 of file ossimImageWriterFactoryRegistry.cpp.

   :
      ossimObjectFactory()
{
}

Member Function Documentation

createObject() [1/2]

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

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 64 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::createObjectFromRegistry().

{
   return createObjectFromRegistry(kwl, prefix);
}

createObject() [2/2]

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

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 70 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::createObjectFromRegistry().

{
   return createObjectFromRegistry(typeName);
}

createWriter() [1/3]

ossimImageFileWriter * ossimImageWriterFactoryRegistry::createWriter

(

const ossimFilename &

filename

)

const

Definition at line 53 of file ossimImageWriterFactoryRegistry.cpp.

References createWriterFromExtension(), ossimString::downcase(), ossimFilename::ext(), and ossimImageFileWriter::setFilename().

Referenced by ossimDemTool::doOMG(), ossimPointCloudTool::execute(), and main().

{
   ossimImageFileWriter * writer = createWriterFromExtension(filename.ext().downcase());
   if(writer)
   {
      writer->setFilename(filename);
   }
   
   return writer;
}

createWriter() [2/3]

ossimImageFileWriter * ossimImageWriterFactoryRegistry::createWriter	(	const ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)		const

Definition at line 93 of file ossimImageWriterFactoryRegistry.cpp.

References createWriterFromExtension(), ossimFilename::ext(), ossimKeywordNames::FILENAME_KW, ossimKeywordlist::find(), ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList, ossimImageFileWriter::setFilename(), and ossimKeywordNames::TYPE_KW.

{
   // let's see if we ned to return an object based on extension.
   // this is specified by the type to be a generic
   // ossimImageFileWriter
   //
   ossimString type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);

   if(type == "ossimImageFileWriter")
   {
      ossimFilename filename = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);

      if((filename != "")&&
         (filename.ext() != ""))
      {
         ossimImageFileWriter* writer = createWriterFromExtension(filename.ext());

         if(writer)
         {
            writer->setFilename(filename);
         }
         return writer;
      }
   }
   
   vector<ossimImageWriterFactoryBase*>::const_iterator factories;
   ossimImageFileWriter *result = NULL;

   factories = m_factoryList.begin();
   while(factories != m_factoryList.end())
   {
      result = (*factories)->createWriter(kwl, prefix);
      if(result)
      {
         return result;
      }
      ++factories;
   }

   return result;
}

createWriter() [3/3]

ossimImageFileWriter * ossimImageWriterFactoryRegistry::createWriter

(

const ossimString &

typeName

)

const

Definition at line 136 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList.

{
   vector<ossimImageWriterFactoryBase*>::const_iterator factories;
   ossimImageFileWriter *result = NULL;

   factories = m_factoryList.begin();
   while(factories != m_factoryList.end())
   {
      result = (*factories)->createWriter(typeName);
      if(result)
      {
         return result;
      }
      ++factories;
   }

   return result;
}

createWriterFromExtension()

ossimImageFileWriter * ossimImageWriterFactoryRegistry::createWriterFromExtension

(

const ossimString &

fileExtension

)

const

Definition at line 80 of file ossimImageWriterFactoryRegistry.cpp.

References getImageFileWritersBySuffix().

Referenced by createWriter().

{
   ossimImageFileWriter *writer = NULL;
   ossimImageWriterFactoryBase::ImageFileWriterList result;
   getImageFileWritersBySuffix(result, fileExtension);
   if(!result.empty())
   {
      writer = result[0].release();
      result.clear();
   }
   return writer;
}

getImageFileWritersByMimeType()

void ossimImageWriterFactoryRegistry::getImageFileWritersByMimeType ( ossimImageWriterFactoryBase::ImageFileWriterList &  result, const ossimString &  mimeType  ) const

virtual

Definition at line 194 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList.

{
   ossimImageWriterFactoryBase::ImageFileWriterList tempResult;
   vector<ossimImageWriterFactoryBase*>::const_iterator iter = m_factoryList.begin();
   
   while(iter != m_factoryList.end())
   {
      result.clear();
      (*iter)->getImageFileWritersByMimeType(tempResult, mimeType);
      
      // now append to the end of the typeList.
      result.insert(result.end(),
                    tempResult.begin(),
                    tempResult.end());
      ++iter;
   }  
}

getImageFileWritersBySuffix()

void ossimImageWriterFactoryRegistry::getImageFileWritersBySuffix ( ossimImageWriterFactoryBase::ImageFileWriterList &  result, const ossimString &  ext  ) const

virtual

Definition at line 174 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList.

Referenced by createWriterFromExtension().

{
   ossimImageWriterFactoryBase::ImageFileWriterList tempResult;
   vector<ossimImageWriterFactoryBase*>::const_iterator iter = m_factoryList.begin();
   
   while(iter != m_factoryList.end())
   {
      result.clear();
      (*iter)->getImageFileWritersBySuffix(tempResult, ext);
      
      // now append to the end of the typeList.
      result.insert(result.end(),
                      tempResult.begin(),
                      tempResult.end());
      ++iter;
   }  
   
}

getImageTypeList()

void ossimImageWriterFactoryRegistry::getImageTypeList ( std::vector< ossimString > &  imageTypeList ) const

virtual

getImageTypeList.

This is the actual image type name. So for example, ossimTiffWriter has several image types. Some of these include TIFF_TILED, TIFF_TILED_BAND_SEPARATE ... etc. The ossimGdalWriter may include GDAL_IMAGINE_HFA, GDAL_RGB_NITF, GDAL_JPEG20000, ... etc A writer should be able to be instantiated by this name as well as a class name

Definition at line 156 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList.

Referenced by printImageTypeList(), and printOutputTypes().

{
   vector<ossimString> result;
   vector<ossimImageWriterFactoryBase*>::const_iterator iter = m_factoryList.begin();
   
   while(iter != m_factoryList.end())
   {
      result.clear();
      (*iter)->getImageTypeList(result);
      
      // now append to the end of the typeList.
      typeList.insert(typeList.end(),
                      result.begin(),
                      result.end());
      ++iter;
   }  
}

getTypeNameList()

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

virtual

getTypeNameList.

This should return the class type of the object being used to perform the writting.

Implements ossimObjectFactory.

Definition at line 75 of file ossimImageWriterFactoryRegistry.cpp.

References ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::getAllTypeNamesFromRegistry().

{
   getAllTypeNamesFromRegistry(typeList);
}

instance()

ossimImageWriterFactoryRegistry * ossimImageWriterFactoryRegistry::instance ( )

static

Definition at line 32 of file ossimImageWriterFactoryRegistry.cpp.

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

Referenced by ossimDemTool::doOMG(), ossimPointCloudTool::execute(), ossimInit::initializeDefaultFactories(), ossimImageWriterFactory::instance(), main(), ossimImageWriterFactoryRegistryGetInstance(), ossimSharedLibraryFinalize(), ossimSharedLibraryInitialize(), printOutputTypes(), ossimInfo::printWriterProps(), and ossimInfo::printWriters().

{
   static ossimImageWriterFactoryRegistry inst;
   static bool initInst = false;
   if(!initInst)
   {
      ossimObjectFactoryRegistry::instance()->registerFactory(&inst);
      ossimImageWriterFactory::instance();
      initInst = true;
   }

   return &inst;
//   if(!theInstance)
//   {
//      theInstance = new ossimImageWriterFactoryRegistry;
//   }

//   return theInstance;
}

operator=()

void ossimImageWriterFactoryRegistry::operator= ( const ossimImageWriterFactoryRegistry &  )

protected

Definition at line 315 of file ossimImageWriterFactoryRegistry.cpp.

{
}

printImageTypeList()

std::ostream & ossimImageWriterFactoryRegistry::printImageTypeList

(

std::ostream &

out

)

const

Prints list of writers from getImageTypeList.

Parameters

out	Stream to print to.

Returns

std::ostream&

Definition at line 213 of file ossimImageWriterFactoryRegistry.cpp.

References getImageTypeList().

Referenced by ossimInfo::printWriters().

{
   std::vector<ossimString> outputType;
   
   this->getImageTypeList(outputType);
   std::copy(outputType.begin(),
             outputType.end(),
             std::ostream_iterator<ossimString>(out, "\n"));
   out << std::endl;
   return out;
}

printWriterProps()

std::ostream & ossimImageWriterFactoryRegistry::printWriterProps

(

std::ostream &

out

)

const

Prints list of writers from getImageTypeList.

Parameters

out	Stream to print to.

Returns

std::ostream&

Definition at line 226 of file ossimImageWriterFactoryRegistry.cpp.

References ossimRefPtr< T >::get(), ossimObject::getClassName(), ossimStringProperty::getConstraints(), ossimImageFileWriter::getImageTypeList(), ossimImageFileWriter::getProperty(), ossimImageFileWriter::getPropertyNames(), ossimFactoryListInterface< ossimImageWriterFactoryBase, ossimImageFileWriter >::m_factoryList, and ossimRefPtr< T >::valid().

Referenced by ossimInfo::printWriterProps().

{
   // Loop through factories:
   vector<ossimImageWriterFactoryBase*>::const_iterator factoryIter = m_factoryList.begin();
   while( factoryIter != m_factoryList.end() )
   {
      out << "factory: " << (*factoryIter)->getClassName() << "\n\n";

      // Loop through writer classes in factory.
      std::vector<ossimString> typeNames;
      (*factoryIter)->getTypeNameList(typeNames);
      std::vector<ossimString>::const_iterator typeNamesIter = typeNames.begin();
      while (typeNamesIter != typeNames.end())
      {
         ossimRefPtr<ossimImageFileWriter> writer = (*factoryIter)->createWriter(*typeNamesIter);
         if ( writer.valid() )
         {
            out << "writer:\n" << writer->getClassName() << "\n";

            // Loop through writer types, e.g. tiff_tiled_band_separate
            std::vector<ossimString> imageTypeList;
            writer->getImageTypeList(imageTypeList);
            std::vector<ossimString>::const_iterator imageTypeListIter = imageTypeList.begin();
            out << "\ntypes:\n";
            while ( imageTypeListIter != imageTypeList.end() )
            {
               out << (*imageTypeListIter) << "\n";
               ++imageTypeListIter;
            }

            // Loop through writer properties:
            std::vector<ossimString> propNames;
            writer->getPropertyNames(propNames);
            if ( propNames.size() )
            {
               out << "\nproperties:\n";
               ossimRefPtr<ossimProperty> prop = 0;
               std::vector<ossimString>::const_iterator p = propNames.begin();
               while ( p != propNames.end() )
               {
                  out << "   " << (*p) << "\n";
                  prop = writer->getProperty( *p );
                  if ( prop.valid() )
                  {
                     ossimStringProperty* stringProp =
                        dynamic_cast<ossimStringProperty*>(prop.get());
                     if ( stringProp )
                     {
                        if ( stringProp->getConstraints().size() )
                        {
                           out << "      constraints:\n";
                           std::vector<ossimString>::const_iterator strPropIter =
                              stringProp->getConstraints().begin();
                           while( strPropIter != stringProp->getConstraints().end() )
                           {
                              out << "         " << (*strPropIter) << "\n";
                              ++strPropIter;
                           }
                        }
                     }
                  }
                  
                  ++p;
               }
               out << "\n";
            }
         }
         ++typeNamesIter;
      }
      
      ++factoryIter;
   }
   return out;
}

---

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

• ossimImageWriterFactoryRegistry.h
• ossimImageWriterFactoryRegistry.cpp