ossimOpjReaderFactory Class Reference

Factory for PNG image reader. More...

#include <ossimOpjReaderFactory.h>

Inheritance diagram for ossimOpjReaderFactory:

Public Member Functions
virtual	~ossimOpjReaderFactory ()
	virtual destructor More...
virtual ossimImageHandler *	open (const ossimFilename &fileName, bool openOverview=true) const
	open that takes a file name. More...
virtual ossimImageHandler *	open (const ossimKeywordlist &kwl, const char *prefix=0) const
	open that takes a keyword list and prefix. More...
virtual ossimRefPtr< ossimImageHandler >	openOverview (const ossimFilename &file) const
	Open overview that takes a file name. More...
virtual ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimOpjReader) More...
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
	Creates and object given a keyword list and prefix. More...
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Adds ossimOpjWriter to the typeList. More...
virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
	Method to add supported extension to the list, like "png". More...
virtual void	getImageHandlersBySuffix (ossimImageHandlerFactoryBase::ImageHandlerList &result, const ossimString &ext) const
	Will add to the result list any handler that supports the passed in extensions. More...
virtual void	getImageHandlersByMimeType (ossimImageHandlerFactoryBase::ImageHandlerList &result, const ossimString &mimeType) const
	Will add to the result list and handler that supports the passed in mime type. More...
Public Member Functions inherited from ossimImageHandlerFactoryBase
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString, bool openOverview=true) const
	Open method that takes a stream. More...
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::ImageHandlerState > state) const
virtual ossimRefPtr< ossimImageHandler >	openOverview (std::shared_ptr< ossim::istream > &str, const ossimString &connectionString) const
	Open method that takes a stream. 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

Static Public Member Functions
static ossimOpjReaderFactory *	instance ()
	static method to return instance (the only one) of this class. More...

Protected Member Functions
bool	hasExcludedExtension (const ossimFilename &file) const
	Method to weed out extensions that this plugin knows it does not support. More...
	ossimOpjReaderFactory ()
	hidden from use default constructor More...
	ossimOpjReaderFactory (const ossimOpjReaderFactory &)
	hidden from use copy constructor More...
void	operator= (const ossimOpjReaderFactory &)
	hidden from use copy constructor More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimOpjReaderFactory *	theInstance = 0
	static instance of this class More...

Additional Inherited Members
Public Types inherited from ossimImageHandlerFactoryBase
typedef UniqueList< ossimString >	UniqueStringList
typedef std::vector< ossimRefPtr< ossimImageHandler > >	ImageHandlerList

Detailed Description

Factory for PNG image reader.

Definition at line 20 of file ossimOpjReaderFactory.h.

Constructor & Destructor Documentation

~ossimOpjReaderFactory()

ossimOpjReaderFactory::~ossimOpjReaderFactory ( )

virtual

virtual destructor

Definition at line 28 of file ossimOpjReaderFactory.cpp.

References theInstance.

{
   theInstance = 0;
}

ossimOpjReaderFactory() [1/2]

ossimOpjReaderFactory::ossimOpjReaderFactory ( )

protected

hidden from use default constructor

Definition at line 240 of file ossimOpjReaderFactory.cpp.

Referenced by instance().

{}

ossimOpjReaderFactory() [2/2]

ossimOpjReaderFactory::ossimOpjReaderFactory ( const ossimOpjReaderFactory &  )

protected

hidden from use copy constructor

Definition at line 242 of file ossimOpjReaderFactory.cpp.

{}

Member Function Documentation

createObject() [1/2]

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

virtual

createObject that takes a class name (ossimOpjReader)

Parameters

typeName

Should be "ossimOpjReader".

Returns

pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 157 of file ossimOpjReaderFactory.cpp.

{
   if(typeName == "ossimOpjJp2Reader")
   {
      return new ossimOpjJp2Reader;
   }
   else if(typeName == "ossimOpjNitfReader")
   {
      return new ossimOpjNitfReader;
   }
   return 0;
}

createObject() [2/2]

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

virtual

Creates and object given a keyword list and prefix.

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns

pointer to image handler on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 171 of file ossimOpjReaderFactory.cpp.

References open().

{
   return this->open(kwl, prefix);
}

getImageHandlersByMimeType()

void ossimOpjReaderFactory::getImageHandlersByMimeType ( ossimImageHandlerFactoryBase::ImageHandlerList &  result, const ossimString &  mimeType  ) const

virtual

Will add to the result list and handler that supports the passed in mime type.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 206 of file ossimOpjReaderFactory.cpp.

References ossimString::begin(), ossimString::end(), and ossimString::push_back().

{
   ossimString test(mimeType.begin(), mimeType.begin()+6);
   if(test == "image/")
   {
      ossimString mimeTypeTest(mimeType.begin() + 6, mimeType.end());
      if( (mimeTypeTest == "jp2") || (mimeTypeTest == "j2k") )
      {
         result.push_back(new ossimOpjJp2Reader);
      }
      else if(mimeTypeTest == "nitf")
      {
         result.push_back(new ossimOpjNitfReader);
      }
   }
}

getImageHandlersBySuffix()

void ossimOpjReaderFactory::getImageHandlersBySuffix ( ossimImageHandlerFactoryBase::ImageHandlerList &  result, const ossimString &  ext  ) const

virtual

Will add to the result list any handler that supports the passed in extensions.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 191 of file ossimOpjReaderFactory.cpp.

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

{
   ossimString testExt = ext.downcase();
   if ( (testExt == "jp2") || (testExt == "j2k") )
   {
      result.push_back( new ossimOpjJp2Reader() );
   }
   else if( (testExt == "ntf") || (testExt == "nitf") )
   {
      result.push_back(new ossimOpjNitfReader() );
   }
}

getSupportedExtensions()

void ossimOpjReaderFactory::getSupportedExtensions ( ossimImageHandlerFactoryBase::UniqueStringList &  extensionList ) const

virtual

Method to add supported extension to the list, like "png".

Parameters

extensionList

The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 185 of file ossimOpjReaderFactory.cpp.

References ossimImageHandlerFactoryBase::UniqueList< T >::push_back().

{
   extensionList.push_back(ossimString("jp2"));
}

getTypeNameList()

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

virtual

Adds ossimOpjWriter to the typeList.

Parameters

typeList

List to add to.

Implements ossimObjectFactory.

Definition at line 178 of file ossimOpjReaderFactory.cpp.

{
   typeList.push_back(ossimString("ossimOpjJp2Reader"));
   typeList.push_back(ossimString("ossimOpjNitfReader"));
}

hasExcludedExtension()

bool ossimOpjReaderFactory::hasExcludedExtension ( const ossimFilename &  file ) const

protected

Method to weed out extensions that this plugin knows it does not support.

This is to avoid a costly open on say a tiff or jpeg that is not handled by this plugin.

Returns

true if extension, false if not.

Definition at line 225 of file ossimOpjReaderFactory.cpp.

References ossimString::downcase(), and ossimFilename::ext().

{
   bool result = false;
   ossimString ext = file.ext().downcase();
   if ( (ext == "tif")  ||
        (ext == "tiff") ||
        (ext == "jpg")  ||
        (ext == "jpeg") ||
        (ext == "png") )
   {
      result = true;
   }
   return result;
}

instance()

ossimOpjReaderFactory * ossimOpjReaderFactory::instance ( )

static

static method to return instance (the only one) of this class.

Returns

pointer to instance of this class.

Definition at line 33 of file ossimOpjReaderFactory.cpp.

References ossimOpjReaderFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

{
   if(!theInstance)
   {
      theInstance = new ossimOpjReaderFactory;
   }
   return theInstance;
}

open() [1/2]

ossimImageHandler * ossimOpjReaderFactory::open ( const ossimFilename &  fileName, bool  openOverview = true  ) const

virtual

open that takes a file name.

Parameters

file	The file to open.
openOverview	If true image handler will attempt to open overview. default = true

Returns

pointer to image handler on success, NULL on failure.

Implements ossimImageHandlerFactoryBase.

Definition at line 42 of file ossimOpjReaderFactory.cpp.

Referenced by createObject().

{
   static const char* M = "ossimOpjReaderFactory::open(filename)";
   
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << M << " Entered with filename:" << fileName
         << "\n";
   }

   ossimRefPtr<ossimImageHandler> reader = 0; 
   while (true)
   {
      if (hasExcludedExtension(fileName))  break;

      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG) << M << " Trying ossimOpjJp2Reader...";
      }
      reader = new ossimOpjJp2Reader();
      reader->setOpenOverviewFlag(openOverview);
      if( reader->open(fileName) ) break;

      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG) << M << " Trying ossimOpjNitfReader...";
      }      
      reader = new ossimOpjNitfReader();
      if( reader->open(fileName) ) break;

      reader = 0;
      break;
   }
   
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << M << " DEBUG: leaving..." << std::endl;
   }
   
   return reader.release();
}

open() [2/2]

ossimImageHandler * ossimOpjReaderFactory::open ( const ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

open that takes a keyword list and prefix.

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns

pointer to image handler on success, NULL on failure.

Implements ossimImageHandlerFactoryBase.

Definition at line 86 of file ossimOpjReaderFactory.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimOpjReaderFactory::open(kwl, prefix) DEBUG: entered..."
         << "Trying ossimOpjReader"
         << std::endl;
   }

   ossimRefPtr<ossimImageHandler> reader = 0; 

   // To save time check the file name first.
   const char* lookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
   if (!lookup)
   {
      // Deprecated...
      lookup = kwl.find(prefix, ossimKeywordNames::IMAGE_FILE_KW);
   }

   if (lookup)
   {
      ossimFilename f = lookup;
      if ( hasExcludedExtension(f) == false )
      {
         reader = new ossimOpjNitfReader;
         if(reader->loadState(kwl, prefix) == false)
         {
            reader = 0;
         }
         
         if (!reader)
         {
            reader = new ossimOpjJp2Reader;
            if(reader->loadState(kwl, prefix) == false)
            {
               reader = 0;
            }
         }
      }
   }
   
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimOpjReaderFactory::open(kwl, prefix) DEBUG: leaving..."
         << std::endl;
   }
   
   return reader.release();
}

openOverview()

ossimRefPtr< ossimImageHandler > ossimOpjReaderFactory::openOverview ( const ossimFilename &  file ) const

virtual

Open overview that takes a file name.

Parameters

file	File to open.

Returns

ossimRefPtr to image handler on success or null on failure.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 139 of file ossimOpjReaderFactory.cpp.

References ossimImageHandler::open(), ossimImageHandler::setOpenOverviewFlag(), and ossimString::size().

{
   ossimRefPtr<ossimImageHandler> result = 0;
   if ( file.size() )
   {
      result = new ossimOpjNitfReader();

      result->setOpenOverviewFlag( false ); // Always false...

      if( result->open( file ) == false )
      {
         result = 0;
      }
   }
   return result;
}

operator=()

void ossimOpjReaderFactory::operator= ( const ossimOpjReaderFactory &  )

protected

hidden from use copy constructor

Definition at line 244 of file ossimOpjReaderFactory.cpp.

{}

Member Data Documentation

theInstance

ossimOpjReaderFactory * ossimOpjReaderFactory::theInstance = 0

staticprotected

static instance of this class

Definition at line 129 of file ossimOpjReaderFactory.h.

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

---

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

• ossimOpjReaderFactory.h
• ossimOpjReaderFactory.cpp