Factory for Hdf image reader. More...

#include <ossimH5ReaderFactory.h>

Inheritance diagram for ossimH5ReaderFactory:

Public Member Functions
virtual	~ossimH5ReaderFactory ()
	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 ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimH5Reader) 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 ossimH5Reader to the typeList. More...

virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
	Method to add supported extension to the list, like "hdf". 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...

virtual void	getImageHandlersBySuffix (ImageHandlerList &result, const ossimString &ext) const

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

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

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

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

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimH5ReaderFactory *	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 Hdf image reader.

Definition at line 23 of file ossimH5ReaderFactory.h.

Constructor & Destructor Documentation

◆ ~ossimH5ReaderFactory()

ossimH5ReaderFactory::~ossimH5ReaderFactory ( )

virtual

virtual destructor

Definition at line 31 of file ossimH5ReaderFactory.cpp.

References theInstance.

 {
    theInstance = 0;
 }

◆ ossimH5ReaderFactory() [1/2]

ossimH5ReaderFactory::ossimH5ReaderFactory ( )

protected

hidden from use default constructor

Definition at line 155 of file ossimH5ReaderFactory.cpp.

Referenced by instance().

155 {}

◆ ossimH5ReaderFactory() [2/2]

ossimH5ReaderFactory::ossimH5ReaderFactory ( const ossimH5ReaderFactory & )

protected

hidden from use copy constructor

Definition at line 157 of file ossimH5ReaderFactory.cpp.

157 {}

Member Function Documentation

◆ createObject() [1/2]

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

virtual

createObject that takes a class name (ossimH5Reader)

Parameters

typeName Should be "ossimH5Reader".

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

Implements ossimObjectFactory.

Definition at line 109 of file ossimH5ReaderFactory.cpp.

References ossimRefPtr< T >::release().

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

◆ createObject() [2/2]

ossimObject * ossimH5ReaderFactory::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 121 of file ossimH5ReaderFactory.cpp.

References open().

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

◆ getSupportedExtensions()

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

virtual

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

Parameters

extensionList The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 134 of file ossimH5ReaderFactory.cpp.

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

 {
    extensionList.push_back(ossimString("h5"));
    extensionList.push_back(ossimString("he5"));
    extensionList.push_back(ossimString("hdf5"));   
 }

◆ getTypeNameList()

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

virtual

Adds ossimH5Reader to the typeList.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 128 of file ossimH5ReaderFactory.cpp.

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

◆ hasExcludedExtension()

bool ossimH5ReaderFactory::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 142 of file ossimH5ReaderFactory.cpp.

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

 {
    bool result = true;
    ossimString ext = file.ext().downcase();
    //only include the file with those extension and exclude any other files
    if ( (ext == "h5") || (ext == "hdf5") || (ext == "he5") )
    {
       result = false;
    }
    return result;
 }

◆ instance()

ossimH5ReaderFactory * ossimH5ReaderFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 36 of file ossimH5ReaderFactory.cpp.

References ossimH5ReaderFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

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

◆ open() [1/2]

ossimImageHandler * ossimH5ReaderFactory::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 45 of file ossimH5ReaderFactory.cpp.

Referenced by createObject().

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimH5ReaderFactory::open(filename) DEBUG: entered..."
          << "\ntrying ossimH5Reader"
          << std::endl;
    }
 
    ossimRefPtr<ossimImageHandler> reader = 0;
 
    if ( hasExcludedExtension(fileName) == false )
    {
       if (reader == 0) //try hdf5 reader
       {
          // cout << "Calling ossimH5Reader ***********************" << endl;
          reader = new ossimHdf5ImageHandler;
          reader->setOpenOverviewFlag(openOverview);
          if(reader->open(fileName) == false)
          {
             reader = 0;
          }
       }
    }
 
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimH5ReaderFactory::open(filename) DEBUG: leaving..."
          << std::endl;
    }
 
    return reader.release();
 }

◆ open() [2/2]

ossimImageHandler * ossimH5ReaderFactory::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 82 of file ossimH5ReaderFactory.cpp.

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

◆ operator=()

void ossimH5ReaderFactory::operator= ( const ossimH5ReaderFactory & )

protected

hidden from use copy constructor

Definition at line 159 of file ossimH5ReaderFactory.cpp.

159 {}

Member Data Documentation

◆ theInstance

ossimH5ReaderFactory * ossimH5ReaderFactory::theInstance = 0

staticprotected

static instance of this class

Definition at line 106 of file ossimH5ReaderFactory.h.

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

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

◆ ~ossimH5ReaderFactory()

◆ ossimH5ReaderFactory() [1/2]

◆ ossimH5ReaderFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getSupportedExtensions()

◆ getTypeNameList()

◆ hasExcludedExtension()

◆ instance()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=()

Member Data Documentation

◆ theInstance