Factory for PNG image reader. More...

#include <ossimPngReaderFactory.h>

Inheritance diagram for ossimPngReaderFactory:

Public Member Functions
virtual	~ossimPngReaderFactory ()
	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 >	open (std::shared_ptr< ossim::istream > &str, const ossimString &connectionString, bool openOverview) const
	Open method that takes a stream. More...

virtual ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimPngReader) 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 ossimPngWriter 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 (ImageHandlerList &result, const ossimString &ext) const

virtual void	getImageHandlersByMimeType (ImageHandlerList &result, const ossimString &mimeType) const

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 ossimPngReaderFactory *	instance ()
	static method to return instance (the only one) of this class. More...

Protected Member Functions
	ossimPngReaderFactory ()
	hidden from use default constructor More...

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

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimPngReaderFactory *	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 22 of file ossimPngReaderFactory.h.

Constructor & Destructor Documentation

◆ ~ossimPngReaderFactory()

ossimPngReaderFactory::~ossimPngReaderFactory ( )

virtual

virtual destructor

Definition at line 29 of file ossimPngReaderFactory.cpp.

References theInstance.

 {
    theInstance = 0;
 }

◆ ossimPngReaderFactory() [1/2]

ossimPngReaderFactory::ossimPngReaderFactory ( )

protected

hidden from use default constructor

Definition at line 188 of file ossimPngReaderFactory.cpp.

Referenced by instance().

188 {}

◆ ossimPngReaderFactory() [2/2]

ossimPngReaderFactory::ossimPngReaderFactory ( const ossimPngReaderFactory & )

protected

hidden from use copy constructor

Definition at line 190 of file ossimPngReaderFactory.cpp.

190 {}

Member Function Documentation

◆ createObject() [1/2]

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

virtual

createObject that takes a class name (ossimPngReader)

Parameters

typeName Should be "ossimPngReader".

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

Implements ossimObjectFactory.

Definition at line 140 of file ossimPngReaderFactory.cpp.

References ossimRefPtr< T >::release().

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

◆ createObject() [2/2]

ossimObject * ossimPngReaderFactory::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 151 of file ossimPngReaderFactory.cpp.

References open().

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

◆ getImageHandlersByMimeType()

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

virtual

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 178 of file ossimPngReaderFactory.cpp.

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

 {
    ossimString testExt = mimeType.downcase();
    if(testExt == "image/png")
    {
       result.push_back(new ossimPngReader);
    }
 }

◆ getImageHandlersBySuffix()

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

virtual

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 168 of file ossimPngReaderFactory.cpp.

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

 {
    ossimString testExt = ext.downcase();
    if(ext == "png")
    {
       result.push_back(new ossimPngReader);
    }
 }

◆ getSupportedExtensions()

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

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

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

◆ getTypeNameList()

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

virtual

Adds ossimPngWriter to the typeList.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 157 of file ossimPngReaderFactory.cpp.

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

◆ instance()

ossimPngReaderFactory * ossimPngReaderFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 34 of file ossimPngReaderFactory.cpp.

References ossimPngReaderFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize().

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

◆ open() [1/3]

ossimImageHandler * ossimPngReaderFactory::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 43 of file ossimPngReaderFactory.cpp.

Referenced by createObject().

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimPngReaderFactory::open(filename) DEBUG: entered..."
          << "\ntrying ossimPngReader"
          << std::endl;
    }
    
    ossimRefPtr<ossimImageHandler> reader = new ossimPngReader;
    reader->setOpenOverviewFlag(openOverview);
    if(reader->open(fileName) == false)
    {
       reader = 0;
    }
    
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimPngReaderFactory::open(filename) DEBUG: leaving..."
          << std::endl;
    }
    
    return reader.release();
 }

◆ open() [2/3]

ossimImageHandler * ossimPngReaderFactory::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 71 of file ossimPngReaderFactory.cpp.

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimPngReaderFactory::open(kwl, prefix) DEBUG: entered..."
          << "Trying ossimPngReader"
          << std::endl;
    }
 
    ossimRefPtr<ossimImageHandler> reader = new ossimPngReader();
    if(reader->loadState(kwl, prefix) == false)
    {
       reader = 0;
    }
    
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimPngReaderFactory::open(kwl, prefix) DEBUG: leaving..."
          << std::endl;
    }
    
    return reader.release();
 }

◆ open() [3/3]

ossimRefPtr< ossimImageHandler > ossimPngReaderFactory::open	(	std::shared_ptr< ossim::istream > &	str,
		const ossimString &	connectionString,
		bool	openOverview
	)		const

virtual

Open method that takes a stream.

Parameters

str	Open stream to image.
connectionString
openOverview	If true attempt to open overview file.

Returns: ossimImageHandler

Definition at line 98 of file ossimPngReaderFactory.cpp.

References ossimRefPtr< T >::get(), ossimPngReader::open(), ossimImageHandlerFactoryBase::openOverview(), and ossimImageHandler::setOpenOverviewFlag().

 {
    ossimRefPtr<ossimImageHandler> result = 0;
    
    // PNG:
    ossimRefPtr<ossimPngReader> ih = new ossimPngReader();
    ih->setOpenOverviewFlag(openOverview);
    if ( ih->open( str, connectionString ) )
    {
       result = ih.get();
    }
    else
    {
       // Reset the stream for downstream code.
       str->seekg(0, std::ios_base::beg);
       str->clear();
    }
    
    return result;
 }

◆ operator=()

void ossimPngReaderFactory::operator= ( const ossimPngReaderFactory & )

protected

hidden from use copy constructor

Definition at line 192 of file ossimPngReaderFactory.cpp.

192 {}

Member Data Documentation

◆ theInstance

ossimPngReaderFactory * ossimPngReaderFactory::theInstance = 0

staticprotected

static instance of this class

Definition at line 132 of file ossimPngReaderFactory.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ossimPngReaderFactory()

◆ ossimPngReaderFactory() [1/2]

◆ ossimPngReaderFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getImageHandlersByMimeType()

◆ getImageHandlersBySuffix()

◆ getSupportedExtensions()

◆ getTypeNameList()

◆ instance()

◆ open() [1/3]

◆ open() [2/3]

◆ open() [3/3]

◆ operator=()

Member Data Documentation

◆ theInstance