Factory for image reader. More...

#include <ossimJpeg12ReaderFactory.h>

Inheritance diagram for ossimJpeg12ReaderFactory:

Public Member Functions
virtual	~ossimJpeg12ReaderFactory ()
	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 overview that takes a file name. More...

virtual ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimJpeg12Reader) 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 ossimJpeg12Writer to the typeList. More...

virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
	Method to add supported extension to the list, like "jp2". 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 (const ossimFilename &file) const
	Open overview that takes a file name. More...

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

	ossimJpeg12ReaderFactory ()
	hidden from use default constructor More...

	ossimJpeg12ReaderFactory (const ossimJpeg12ReaderFactory &)
	hidden from use copy constructor More...

void	operator= (const ossimJpeg12ReaderFactory &)
	hidden from use copy constructor More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Additional Inherited Members
Public Types inherited from ossimImageHandlerFactoryBase
typedef UniqueList< ossimString >	UniqueStringList

typedef std::vector< ossimRefPtr< ossimImageHandler > >	ImageHandlerList

Detailed Description

Factory for image reader.

Definition at line 21 of file ossimJpeg12ReaderFactory.h.

Constructor & Destructor Documentation

◆ ~ossimJpeg12ReaderFactory()

ossimJpeg12ReaderFactory::~ossimJpeg12ReaderFactory ( )

virtual

virtual destructor

Definition at line 28 of file ossimJpeg12ReaderFactory.cpp.

29 {

30 }

◆ ossimJpeg12ReaderFactory() [1/2]

ossimJpeg12ReaderFactory::ossimJpeg12ReaderFactory ( )

protected

hidden from use default constructor

Definition at line 192 of file ossimJpeg12ReaderFactory.cpp.

192 {}

◆ ossimJpeg12ReaderFactory() [2/2]

ossimJpeg12ReaderFactory::ossimJpeg12ReaderFactory ( const ossimJpeg12ReaderFactory & )

protected

hidden from use copy constructor

Definition at line 194 of file ossimJpeg12ReaderFactory.cpp.

194 {}

Member Function Documentation

◆ createObject() [1/2]

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

virtual

createObject that takes a class name (ossimJpeg12Reader)

Parameters

typeName Should be "ossimJpeg12Reader".

Returns: pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 113 of file ossimJpeg12ReaderFactory.cpp.

References ossimRefPtr< T >::release().

 {
    ossimRefPtr<ossimObject> result = 0;
    if(typeName == "ossimJpeg12NitfReader")
    {
       result = new ossimJpeg12NitfReader;
    }
    return result.release();
 }

◆ createObject() [2/2]

ossimObject * ossimJpeg12ReaderFactory::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 124 of file ossimJpeg12ReaderFactory.cpp.

References open().

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

◆ getImageHandlersByMimeType()

void ossimJpeg12ReaderFactory::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 176 of file ossimJpeg12ReaderFactory.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 == "nitf")
       {
          result.push_back(new ossimJpeg12NitfReader);
       }
    }
 }

◆ getImageHandlersBySuffix()

void ossimJpeg12ReaderFactory::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 162 of file ossimJpeg12ReaderFactory.cpp.

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

 {
    ossimString testExt = ext.downcase();
    if( (testExt == "ntf") || (testExt == "nitf") )
    {
       result.push_back(new ossimJpeg12NitfReader);
    }
 }

◆ getSupportedExtensions()

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

virtual

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

Parameters

extensionList The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 137 of file ossimJpeg12ReaderFactory.cpp.

 {
    /* Nothing to do here. */
 }

◆ getTypeNameList()

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

virtual

Adds ossimJpeg12Writer to the typeList.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 131 of file ossimJpeg12ReaderFactory.cpp.

 {
    typeList.push_back(ossimString("ossimJpeg12NitfReader"));
 }

◆ hasExcludedExtension()

bool ossimJpeg12ReaderFactory::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 143 of file ossimJpeg12ReaderFactory.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()

ossimJpeg12ReaderFactory * ossimJpeg12ReaderFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 32 of file ossimJpeg12ReaderFactory.cpp.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

 {
    static ossimJpeg12ReaderFactory inst;
    return &inst;
 }

◆ open() [1/2]

ossimImageHandler * ossimJpeg12ReaderFactory::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 38 of file ossimJpeg12ReaderFactory.cpp.

Referenced by createObject().

 {
    static const char* M = "ossimJpeg12ReaderFactory::open(filename) -- ";
    if(traceDebug())
       ossimNotify(ossimNotifyLevel_DEBUG)<<M<<"Entered with filename <"<<fileName<<">"  ;
 
    ossimRefPtr<ossimImageHandler> reader = 0; 
    while (true)
    {
       if (hasExcludedExtension(fileName))  break;
 
       if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "Trying ossimJpeg12NitfReader...";
       reader = new ossimJpeg12NitfReader;
       reader->setOpenOverviewFlag(openOverview);
       if(reader->open(fileName))  break;
 
       reader = 0;
       break;
    } 
    
    if (traceDebug())
    {
       if (reader.valid())
          ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "   SUCCESS" << std::endl;
       else
          ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "   Open FAILED" << std::endl;
    }
  
    return reader.release();
 }

◆ open() [2/2]

ossimImageHandler * ossimJpeg12ReaderFactory::open	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		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.

Implements ossimImageHandlerFactoryBase.

Definition at line 70 of file ossimJpeg12ReaderFactory.cpp.

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimJpeg12ReaderFactory::open(kwl, prefix) DEBUG: entered..."
          << 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 ossimJpeg12NitfReader;
          if(reader->loadState(kwl, prefix) == false)
          {
             reader = 0;
          }
       }
    }
 
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimJpeg12ReaderFactory::open(kwl, prefix) DEBUG: leaving..."
          << std::endl;
    }
    
    return reader.release();
 }

◆ operator=()

void ossimJpeg12ReaderFactory::operator= ( const ossimJpeg12ReaderFactory & )

protected

hidden from use copy constructor

Definition at line 196 of file ossimJpeg12ReaderFactory.cpp.

196 {}

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ossimJpeg12ReaderFactory()

◆ ossimJpeg12ReaderFactory() [1/2]

◆ ossimJpeg12ReaderFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getImageHandlersByMimeType()

◆ getImageHandlersBySuffix()

◆ getSupportedExtensions()

◆ getTypeNameList()

◆ hasExcludedExtension()

◆ instance()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=()