Factory for Hdf image reader. More...

#include <ossimHdf5PluginHandlerFactory.h>

Inheritance diagram for ossimHdf5PluginHandlerFactory:

Public Member Functions
virtual	~ossimHdf5PluginHandlerFactory ()
	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 &list) const
	Method to add supported extension to the list, like "hdf". More...

virtual void	getSupportedRenderableNames (std::vector< ossimString > &names) const
	HDF5 defines different datasets depending on the sensor/format. 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 ossimHdf5PluginHandlerFactory *	instance ()
	static method to return instance (the only one) of this class. More...

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

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

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimHdf5PluginHandlerFactory *	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 ossimHdf5PluginHandlerFactory.h.

Constructor & Destructor Documentation

◆ ~ossimHdf5PluginHandlerFactory()

ossimHdf5PluginHandlerFactory::~ossimHdf5PluginHandlerFactory ( )

virtual

virtual destructor

Definition at line 26 of file ossimHdf5PluginHandlerFactory.cpp.

References theInstance.

 {
    theInstance = 0;
 }

◆ ossimHdf5PluginHandlerFactory() [1/2]

ossimHdf5PluginHandlerFactory::ossimHdf5PluginHandlerFactory ( )

protected

hidden from use default constructor

Definition at line 138 of file ossimHdf5PluginHandlerFactory.cpp.

Referenced by instance().

138 {}

◆ ossimHdf5PluginHandlerFactory() [2/2]

ossimHdf5PluginHandlerFactory::ossimHdf5PluginHandlerFactory ( const ossimHdf5PluginHandlerFactory & )

protected

hidden from use copy constructor

Definition at line 140 of file ossimHdf5PluginHandlerFactory.cpp.

140 {}

Member Function Documentation

◆ createObject() [1/2]

ossimObject * ossimHdf5PluginHandlerFactory::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 93 of file ossimHdf5PluginHandlerFactory.cpp.

References ossimRefPtr< T >::release().

 {
    ossimRefPtr<ossimObject> result = 0;
    if(typeName == "ossimViirsHandler")
       result = new ossimViirsHandler;
 
    // Add other sensors here:
 
    return result.release();
 }

◆ createObject() [2/2]

ossimObject * ossimHdf5PluginHandlerFactory::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 104 of file ossimHdf5PluginHandlerFactory.cpp.

References open().

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

◆ getSupportedExtensions()

void ossimHdf5PluginHandlerFactory::getSupportedExtensions ( ossimImageHandlerFactoryBase::UniqueStringList & list ) const

virtual

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

Parameters

extensionList The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 118 of file ossimHdf5PluginHandlerFactory.cpp.

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

Referenced by open().

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

◆ getSupportedRenderableNames()

void ossimHdf5PluginHandlerFactory::getSupportedRenderableNames ( std::vector< ossimString > & names ) const

virtual

HDF5 defines different datasets depending on the sensor/format.

This static method provides all dataset names to the plugin intialization for populating a description.

Definition at line 126 of file ossimHdf5PluginHandlerFactory.cpp.

References ossimHdf5ImageHandler::getRenderableSetNames().

 {
    names.clear();
 
    // Fetch all sensors represented by this plugin. Start with VIIRS:
    ossimViirsHandler viirs;
    const vector<ossimString>& viirsRenderables = viirs.getRenderableSetNames();
    names.insert(names.end(), viirsRenderables.begin(), viirsRenderables.end());
 
    // Add other sensors here:
 }

◆ getTypeNameList()

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

virtual

Adds ossimH5Reader to the typeList.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 111 of file ossimHdf5PluginHandlerFactory.cpp.

 {
    typeList.push_back(ossimString("ossimViirsHandler"));
    // Add other sensors here:
 }

◆ instance()

ossimHdf5PluginHandlerFactory * ossimHdf5PluginHandlerFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 31 of file ossimHdf5PluginHandlerFactory.cpp.

References ossimHdf5PluginHandlerFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

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

◆ open() [1/2]

ossimImageHandler * ossimHdf5PluginHandlerFactory::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 40 of file ossimHdf5PluginHandlerFactory.cpp.

References ossimString::downcase(), ossimFilename::ext(), getSupportedExtensions(), ossimImageHandler::open(), ossimImageHandlerFactoryBase::openOverview(), ossimRefPtr< T >::release(), ossimImageHandler::setOpenOverviewFlag(), and ossimImageHandlerFactoryBase::UniqueList< T >::size().

Referenced by createObject().

 {
    ossimImageHandlerFactoryBase::UniqueStringList extensionList;
    getSupportedExtensions(extensionList);
 
    ossimString ext = fileName.ext().downcase();
    bool ext_handled = false;
    for (int i=0; (i<extensionList.size()) && !ext_handled ; ++i)
    {
       if (ext == extensionList[i])
          ext_handled = true;
    }
    if (!ext_handled)
        return NULL;
 
    // Now try each of the represented concrete types in this plugin:
    ossimRefPtr<ossimImageHandler> reader = 0;
    while (1)
    {
       // VIIRS:
       reader = new ossimViirsHandler;
       reader->setOpenOverviewFlag(openOverview);
       if(reader->open(fileName))
          break;
 
       // Add other sensors here:
 
       reader = 0;
       break;
    }
 
    return reader.release();
 }

◆ open() [2/2]

ossimImageHandler * ossimHdf5PluginHandlerFactory::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 75 of file ossimHdf5PluginHandlerFactory.cpp.

References ossimImageHandler::loadState(), and ossimRefPtr< T >::release().

 {
    ossimRefPtr<ossimImageHandler> reader = 0;
    while (1)
    {
       // VIIRS:
       reader = new ossimViirsHandler;
       if(reader->loadState(kwl, prefix))
          break;
 
       // Add other sensors here:
       reader = 0;
       break;
    }
    return reader.release();
 }

◆ operator=()

void ossimHdf5PluginHandlerFactory::operator= ( const ossimHdf5PluginHandlerFactory & )

protected

hidden from use copy constructor

Definition at line 142 of file ossimHdf5PluginHandlerFactory.cpp.

142 {}

Member Data Documentation

◆ theInstance

ossimHdf5PluginHandlerFactory * ossimHdf5PluginHandlerFactory::theInstance = 0

staticprotected

static instance of this class

Definition at line 102 of file ossimHdf5PluginHandlerFactory.h.

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

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

◆ ~ossimHdf5PluginHandlerFactory()

◆ ossimHdf5PluginHandlerFactory() [1/2]

◆ ossimHdf5PluginHandlerFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getSupportedExtensions()

◆ getSupportedRenderableNames()

◆ getTypeNameList()

◆ instance()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=()

Member Data Documentation

◆ theInstance