ossimImageWriterFactory Class Reference

#include <ossimImageWriterFactory.h>

Inheritance diagram for ossimImageWriterFactory:

Public Member Functions
virtual	~ossimImageWriterFactory ()
ossimImageFileWriter *	createWriterFromExtension (const ossimString &fileExtension) const
virtual ossimImageFileWriter *	createWriter (const ossimKeywordlist &kwl, const char *prefix=0) const
virtual ossimImageFileWriter *	createWriter (const ossimString &typeName) const
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
virtual ossimObject *	createObject (const ossimString &typeName) const
virtual void	getExtensions (std::vector< ossimString > &result) const
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
virtual void	getImageTypeList (std::vector< ossimString > &imageTypeList) const
virtual void	getImageFileWritersBySuffix (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &ext) const
virtual void	getImageFileWritersByMimeType (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &mimeType) const
Public Member Functions inherited from ossimImageWriterFactoryBase
virtual	~ossimImageWriterFactoryBase ()
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

Static Public Member Functions
static ossimImageWriterFactory *	instance ()

Protected Member Functions
	ossimImageWriterFactory ()
ossimImageFileWriter *	createFromMimeType (const ossimString &mimeType) const
bool	isImageTypeName (const ossimString &name) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimImageWriterFactory *	theInstance = (ossimImageWriterFactory*)NULL

Additional Inherited Members
Public Types inherited from ossimImageWriterFactoryBase
typedef std::vector< ossimRefPtr< ossimImageFileWriter > >	ImageFileWriterList

Detailed Description

Definition at line 20 of file ossimImageWriterFactory.h.

Constructor & Destructor Documentation

~ossimImageWriterFactory()

ossimImageWriterFactory::~ossimImageWriterFactory ( )

virtual

Definition at line 39 of file ossimImageWriterFactory.cpp.

References theInstance.

{
   theInstance = (ossimImageWriterFactory*)NULL;
}

ossimImageWriterFactory()

ossimImageWriterFactory::ossimImageWriterFactory ( )

inlineprotected

Definition at line 55 of file ossimImageWriterFactory.h.

Referenced by instance().

{}

Member Function Documentation

createFromMimeType()

ossimImageFileWriter * ossimImageWriterFactory::createFromMimeType ( const ossimString &  mimeType ) const

protected

Definition at line 250 of file ossimImageWriterFactory.cpp.

References ossimImageFileWriter::setOutputImageType().

Referenced by createWriter().

{
   if((mimeType == "image/jpeg")||
      (mimeType == "image/jpg"))
   {
      ossimJpegWriter* writer = new ossimJpegWriter;
      writer->setOutputImageType("jpeg");
      return writer;
   }
   else if((mimeType == "image/tiff")||
           (mimeType == "image/tif")||
           (mimeType == "image/gtif")||
           (mimeType == "image/gtiff"))
   {
      ossimTiffWriter* writer = new ossimTiffWriter;
      writer->setOutputImageType("tiff_tiled_band_separate");
      return writer;
   }
   else if((mimeType == "image/nitf") ||
           (mimeType == "image/ntf"))
   {
      ossimNitfWriter* writer = new ossimNitfWriter;
      writer->setOutputImageType("nitf_block_band_separate");
      return writer;
   }
   else if((mimeType == "image/ras"))
   {
      ossimGeneralRasterWriter* writer = new ossimGeneralRasterWriter;
      writer->setOutputImageType("general_raster_bsq");
      return writer;
   }
   else if((mimeType == "application/pdf")||
           (mimeType == "image/pdf"))
   {
      ossimPdfWriter* writer = new ossimPdfWriter;
      writer->setOutputImageType("ossim_pdf");
      return writer;
   }
   return 0;
}

createObject() [1/2]

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

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 292 of file ossimImageWriterFactory.cpp.

References createWriter().

{
   return createWriter(kwl, prefix);
}

createObject() [2/2]

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

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 298 of file ossimImageWriterFactory.cpp.

References createWriter().

{
   return createWriter(typeName);
}

createWriter() [1/2]

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

virtual

Implements ossimImageWriterFactoryBase.

Definition at line 89 of file ossimImageWriterFactory.cpp.

References ossimKeywordlist::add(), ossimKeywordlist::find(), ossimImageFileWriter::hasImageType(), ossimKeywordNames::IMAGE_TYPE_KW, ossimImageFileWriter::loadState(), and ossimKeywordNames::TYPE_KW.

Referenced by createObject().

{
   ossimString type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
   ossimImageFileWriter* result = (ossimImageFileWriter*)NULL;
   
   if(type != "")
   {
      result = createWriter(type);
      if (result)
      {
         if (result->hasImageType(type))
         {
            ossimKeywordlist kwl2(kwl);
            kwl2.add(prefix,
                     ossimKeywordNames::IMAGE_TYPE_KW,
                     type,
                     true);
         
            result->loadState(kwl2, prefix);
         }
         else
         {
            result->loadState(kwl, prefix);
         }
      }
   }

   return result;
}

createWriter() [2/2]

ossimImageFileWriter * ossimImageWriterFactory::createWriter ( const ossimString &  typeName ) const

virtual

Implements ossimImageWriterFactoryBase.

Definition at line 121 of file ossimImageWriterFactory.cpp.

References createFromMimeType(), ossimString::downcase(), ossimObject::getClassName(), ossimImageFileWriter::hasImageType(), ossimRefPtr< T >::release(), ossimImageFileWriter::setOutputImageType(), STATIC_TYPE_NAME, and ossimRefPtr< T >::valid().

{
   ossimString mimeType = typeName;
   mimeType = mimeType.downcase();
    
   // Check for tiff writer.
   ossimRefPtr<ossimImageFileWriter> writer = createFromMimeType(mimeType);
    
   if(writer.valid())
   {
      return writer.release();
   }
 
   // Check for generic ossim writer.
   writer = new ossimWriter;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }

   writer = new ossimTiffWriter;
   if (STATIC_TYPE_NAME(ossimTiffWriter) == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }

   // Check for jpeg writer.
   writer = new ossimJpegWriter;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }
    
   // Check for general raster writer.
   writer = new ossimGeneralRasterWriter;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }

   // Check for nitf writer.
   writer = new ossimNitfWriter;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }

   // Check for nitf writer.
   writer = new ossimNitf20Writer;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }

   // Check for pdf writer.
   writer = new ossimPdfWriter;
   if ( writer->getClassName() == typeName )
   {
      return writer.release();
   }
   else
   {
      // See if the type name is supported by the writer.
      if ( writer->hasImageType(typeName) )
      {
         writer->setOutputImageType(typeName);
         return writer.release();
      }
   }
   
   writer = 0; // Not a nitf writer.   

   return writer.release(); // Return a null writer.
}

createWriterFromExtension()

ossimImageFileWriter * ossimImageWriterFactory::createWriterFromExtension

(

const ossimString &

fileExtension

)

const

Definition at line 44 of file ossimImageWriterFactory.cpp.

References ossimString::downcase(), OSSIM_GENERAL_RASTER_BIL, OSSIM_GENERAL_RASTER_BIP, and ossimImageFileWriter::setOutputImageType().

{
   ossimImageFileWriter* result = 0;

   ossimString ext = fileExtension;
   ext.downcase();
   
   if( (ext == "tif")|| (ext == "tiff") )
   {
      result = new ossimTiffWriter;
   }
   else if( (ext == "jpg")|| (ext == "jpeg") )
   {
      result = new ossimJpegWriter;
   }
   else if( (ext == "ras") || (ext == "bsq") )
   {
      // Default is OSSIM_GENERAL_RASTER_BSQ
      result = new ossimGeneralRasterWriter;
   }
   else if(ext == "bil")
   {
      result = new ossimGeneralRasterWriter;
      result->setOutputImageType(OSSIM_GENERAL_RASTER_BIL);
   }
   else if(ext == "bip")
   {
      result = new ossimGeneralRasterWriter;
      result->setOutputImageType(OSSIM_GENERAL_RASTER_BIP);
   }
   else if((ext == "ntf")||
           (ext == "nitf"))
   {
      result = new ossimNitfWriter;
   }
   else if( ext == "pdf" )
   {
      result = new ossimPdfWriter;
   }
   
   return result;
}

getExtensions()

void ossimImageWriterFactory::getExtensions ( std::vector< ossimString > &  result ) const

virtual

Implements ossimImageWriterFactoryBase.

Definition at line 303 of file ossimImageWriterFactory.cpp.

{
   result.push_back("ras");
   result.push_back("bsq");
   result.push_back("bil");
   result.push_back("bip");
   result.push_back("tif");
   result.push_back("jpg");
   result.push_back("ntf");
   result.push_back("pdf");
}

getImageFileWritersByMimeType()

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

virtual

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 352 of file ossimImageWriterFactory.cpp.

References ossimString::begin(), ossimString::downcase(), ossimString::end(), and getImageFileWritersBySuffix().

{
   ossimString testExt = mimeType.downcase();
   testExt = ossimString(testExt.begin()+6, testExt.end());
   
   getImageFileWritersBySuffix(result, testExt);
}

getImageFileWritersBySuffix()

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

virtual

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 326 of file ossimImageWriterFactory.cpp.

References ossimString::downcase(), and ossimString::push_back().

Referenced by getImageFileWritersByMimeType().

{
   ossimString testExt = ext.downcase();
   if(testExt == "tiff" || testExt == "tif")
   {
      result.push_back(new ossimTiffWriter);
   }
   else if(testExt == "ntf" || testExt == "nitf")
   {
      result.push_back(new ossimNitfWriter);
   }
   else if(testExt == "jpg" || testExt == "jpeg")
   {
      result.push_back(new ossimJpegWriter);
   }
   else if(testExt == "ras" || testExt == "bsq" || testExt == "bil" || testExt == "bip")
   {
      result.push_back(new ossimGeneralRasterWriter);
   }
   else if( testExt == "pdf" )
   {
      result.push_back( new ossimPdfWriter );
   }
}

getImageTypeList()

void ossimImageWriterFactory::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

Implements ossimImageWriterFactoryBase.

Definition at line 361 of file ossimImageWriterFactory.cpp.

References ossimImageFileWriter::getImageTypeList().

{
   // Add the tiff writer types.
   ossimRefPtr<ossimImageFileWriter> writer = new ossimTiffWriter;
   writer->getImageTypeList(imageTypeList);

   // Add the jpeg writer types.
   writer = new ossimJpegWriter;
   writer->getImageTypeList(imageTypeList);

   // Add the general raster writer types.
   writer = new ossimGeneralRasterWriter;
   writer->getImageTypeList(imageTypeList);

   // Add the nitf writer types.
   writer = new ossimNitfWriter;
   writer->getImageTypeList(imageTypeList);
   
   // Add the nitf writer types.
   writer = new ossimNitf20Writer;
   writer->getImageTypeList(imageTypeList);
   
   // Add the pdf writer types.
   writer = new ossimPdfWriter;
   writer->getImageTypeList(imageTypeList);
   
   // Add the generic ossim writer types.
   writer = new ossimWriter;
   writer->getImageTypeList(imageTypeList);
   
   writer = 0;
}

getTypeNameList()

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

virtual

This should return the type name of all objects in all factories. This is the name used to construct the objects dynamially and this name must be unique.

Implements ossimObjectFactory.

Definition at line 315 of file ossimImageWriterFactory.cpp.

References STATIC_TYPE_NAME.

{
   typeList.push_back(STATIC_TYPE_NAME(ossimTiffWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimJpegWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimGeneralRasterWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimNitfWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimNitf20Writer));
   typeList.push_back(STATIC_TYPE_NAME(ossimPdfWriter));
   typeList.push_back(ossimString("ossimWriter"));
}

instance()

ossimImageWriterFactory * ossimImageWriterFactory::instance ( )

static

Definition at line 28 of file ossimImageWriterFactory.cpp.

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

Referenced by ossimImageWriterFactoryRegistry::instance().

{
   if(!theInstance)
   {
      theInstance = new ossimImageWriterFactory;
      ossimImageWriterFactoryRegistry::instance()->registerFactory(theInstance);
   }

   return theInstance;
}

isImageTypeName()

bool ossimImageWriterFactory::isImageTypeName ( const ossimString &  name ) const

protected

Member Data Documentation

theInstance

ossimImageWriterFactory * ossimImageWriterFactory::theInstance = (ossimImageWriterFactory*)NULL

staticprotected

Definition at line 57 of file ossimImageWriterFactory.h.

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

---

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

• ossimImageWriterFactory.h
• ossimImageWriterFactory.cpp