ossimImageHandlerRegistry Class Reference

ossimImageHandlerRegistry supports the new state cache. More...

#include <ossimImageHandlerRegistry.h>

Inheritance diagram for ossimImageHandlerRegistry:

Public Member Functions
virtual	~ossimImageHandlerRegistry ()
std::shared_ptr< ossim::ImageHandlerState >	getState (const ossimString &connectionString, ossim_uint32 entry) const
std::shared_ptr< ossim::ImageHandlerState >	getState (const ossimString &id) const
ossimRefPtr< ossimImageHandler >	openConnection (const ossimString &connectionString, bool openOverview=true) const
virtual ossimImageHandler *	open (const ossimFilename &fileName, bool trySuffixFirst=true, bool openOverview=true) const
	open that takes a filename. More...
virtual ossimImageHandler *	open (const ossimKeywordlist &kwl, const char *prefix=0) const
	Given a keyword list return a pointer to an ImageHandler. More...
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::ImageHandlerState > state) const
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString, bool openOverview) const
	Open method that takes a stream. More...
virtual ossimRefPtr< ossimImageHandler >	openOverview (const ossimFilename &file) const
	Open overview that takes a file name. More...
virtual ossimObject *	createObject (const ossimString &typeName) const
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
virtual ossimRefPtr< ossimImageHandler >	openBySuffix (const ossimFilename &file, bool openOverview=true) const
	openBySuffix will call the mthod getImageHandlersBySuffix and go through each handler to try and open the file. 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...
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
std::ostream &	printReaderProps (std::ostream &out) const
	Prints list of readers and properties. 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
Public Member Functions inherited from ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >
	ossimFactoryListInterface ()
void	addFactory (ossimImageHandlerFactoryBase *factory)
	This is for backward compatability and calls registerFactory for simple adds. More...
bool	isFactoryRegistered (ossimImageHandlerFactoryBase *factory) const
	Public access method to determine if a factory is already registered to this list. More...
void	registerFactory (ossimImageHandlerFactoryBase *factory, bool pushToFrontFlag=false)
	Will register a factory to the factory list. More...
void	unregisterFactory (ossimImageHandlerFactoryBase *factory)
	Will remove the factory from the registry. More...
void	unregisterFactory (const ossimString &factoryTypeName)
	Will remove the factory from the registry by name. More...
void	unregisterAllFactories ()
	Will remove all factories from the registry. More...
void	registerFactoryToFront (ossimImageHandlerFactoryBase *factory)
	Inserts the factory to the front of the list. More...
void	registerFactoryBefore (ossimImageHandlerFactoryBase *factory, ossimImageHandlerFactoryBase *beforeThisFactory)
	Will insert the factory before the beforeThisFactory. More...
void	getAllTypeNamesFromRegistry (std::vector< ossimString > &typeList) const
	Will add all object types the factories can allocate. More...
ossimObject *	createObjectFromRegistry (const ossimString &typeName) const
	This is the base object return for all objects in the system. More...
ossimObject *	createObjectFromRegistry (const ossimKeywordlist &kwl, const char *prefix=0) const
	This is the base object return for all objects in the system. More...
ossimImageHandler *	createNativeObjectFromRegistry (const ossimString &typeName) const
	This is a helper method that calls the createObject and makes sure that the returned object is of the NativeType base type this registry supports. More...
ossimImageHandler *	createNativeObjectFromRegistry (const ossimKeywordlist &kwl, const char *prefix=0) const
	This is a helper method that calls the createObject and makes sure that the returned object is of the NativeType base type this registry supports. More...

Static Public Member Functions
static ossimImageHandlerRegistry *	instance ()

Protected Member Functions
	ossimImageHandlerRegistry ()
	ossimImageHandlerRegistry (const ossimImageHandlerRegistry &rhs)
const ossimImageHandlerRegistry &	operator= (const ossimImageHandlerRegistry &rhs)
void	initializeStateCache () const
void	addToStateCache (ossimImageHandler *handler) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >
bool	findFactory (ossimImageHandlerFactoryBase *factory) const
	Utility to find a factory in the list. More...

Protected Attributes
std::shared_ptr< ossim::ItemCache< ossim::ImageHandlerState > >	m_stateCache
Protected Attributes inherited from ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >
std::mutex	m_factoryListMutex
FactoryListType	m_factoryList

Additional Inherited Members
Public Types inherited from ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >
typedef std::vector< ossimImageHandlerFactoryBase *>	FactoryListType
typedef ossimImageHandlerFactoryBase	FactoryType
typedef ossimImageHandler	NativeReturnType

Detailed Description

ossimImageHandlerRegistry supports the new state cache.

During initialization the properties are read from the global preferences. The keywords are:

ossim.imaging.handler.registry.state_cache.enabled: true or false ossim.imaging.handler.registry.state_cache.min_size: min number of items ossim.imaging.handler.registry.state_cache.max_size: max number of items

On open if the state cache is enabled it will determine if a state exists when a file is passed in to be open and if a state exists it will try to open the handler based on the state.

Definition at line 41 of file ossimImageHandlerRegistry.h.

Constructor & Destructor Documentation

~ossimImageHandlerRegistry()

ossimImageHandlerRegistry::~ossimImageHandlerRegistry ( )

virtual

Definition at line 48 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::unregisterAllFactories().

{
   unregisterAllFactories();
}

ossimImageHandlerRegistry() [1/2]

ossimImageHandlerRegistry::ossimImageHandlerRegistry ( )

protected

Definition at line 34 of file ossimImageHandlerRegistry.cpp.

References initializeStateCache(), ossimObjectFactoryRegistry::instance(), ossimImageHandlerFactory::instance(), ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::registerFactory(), and ossimFactoryListInterface< T, NativeType >::registerFactory().

{
   ossimObjectFactoryRegistry::instance()->registerFactory(this);
   registerFactory(ossimImageHandlerFactory::instance());
   initializeStateCache();
}

ossimImageHandlerRegistry() [2/2]

ossimImageHandlerRegistry::ossimImageHandlerRegistry ( const ossimImageHandlerRegistry &  rhs )

protected

Definition at line 542 of file ossimImageHandlerRegistry.cpp.

   :  ossimObjectFactory()
{}

Member Function Documentation

addToStateCache()

void ossimImageHandlerRegistry::addToStateCache ( ossimImageHandler *  handler ) const

protected

Definition at line 583 of file ossimImageHandlerRegistry.cpp.

References ossimImageHandler::getFilename(), ossimImageHandler::getState(), m_stateCache, and ossimString::toString().

Referenced by open().

{
   if(handler)
   {
      std::shared_ptr<ossim::ImageHandlerState> state = handler->getState();
      if(state&&m_stateCache)
      {
         ossimString id = handler->getFilename()+"_e"+ossimString::toString(state->getCurrentEntry());
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::addToStateCache: " << id << std::endl;
         }
         m_stateCache->addItem(id, state);
      }
   }
}

createObject() [1/2]

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

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 471 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::createObjectFromRegistry().

{
   return createObjectFromRegistry(typeName);
}

createObject() [2/2]

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

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 54 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::createObjectFromRegistry(), and open().

{
   ossimObject* result = createObjectFromRegistry(kwl, prefix);
   if(!result)
   {
      result = open(kwl, prefix);
   }
   return result;
}

getImageHandlersByMimeType()

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

virtual

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

Definition at line 108 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList.

{
   vector<ossimImageHandlerFactoryBase*>::const_iterator iter = m_factoryList.begin();
   ossimImageHandlerFactoryBase::ImageHandlerList temp;
   while(iter != m_factoryList.end())
   {
      temp.clear();
      (*iter)->getImageHandlersByMimeType(temp, mimeType);
      
      if(!temp.empty())
      {
         
         // now append to the end of the typeList.
         result.insert(result.end(),
                       temp.begin(),
                       temp.end());
      }
      ++iter;
   }
}

getImageHandlersBySuffix()

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

virtual

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

Definition at line 86 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList.

Referenced by openBySuffix().

{
   vector<ossimImageHandlerFactoryBase*>::const_iterator iter = m_factoryList.begin();
   ossimImageHandlerFactoryBase::ImageHandlerList temp;
   while(iter != m_factoryList.end())
   {
      temp.clear();
      (*iter)->getImageHandlersBySuffix(temp, ext);
      
      if(!temp.empty())
      {
         
         // now append to the end of the typeList.
         result.insert(result.end(),
                       temp.begin(),
                       temp.end());
      }
      ++iter;
   }
}

getState() [1/2]

std::shared_ptr< ossim::ImageHandlerState > ossimImageHandlerRegistry::getState	(	const ossimString &	connectionString,
		ossim_uint32	entry
	)		const

Definition at line 151 of file ossimImageHandlerRegistry.cpp.

References ossimString::toString().

{
   return getState(connectionString + "_e" + ossimString::toString(entry));
}

getState() [2/2]

std::shared_ptr< ossim::ImageHandlerState > ossimImageHandlerRegistry::getState

(

const ossimString &

id

)

const

Definition at line 157 of file ossimImageHandlerRegistry.cpp.

References m_stateCache.

{
   std::shared_ptr<ossim::ImageHandlerState> result;

   if(m_stateCache)
   {
      result = m_stateCache->getItem(id);
   }

   return result;
}

getSupportedExtensions()

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

virtual

Definition at line 135 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList.

Referenced by ossimInfo::printExtensions().

{
   vector<ossimString> result;
   vector<ossimImageHandlerFactoryBase*>::const_iterator iter = m_factoryList.begin();

   while(iter != m_factoryList.end())
   {
      (*iter)->getSupportedExtensions(extensionList);

      ++iter;
   }
   
}

getTypeNameList()

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

virtual

This should return the type name of all objects in all factories. This is the name used to construct the objects dynamially and this name must be unique.

Implements ossimObjectFactory.

Definition at line 130 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::getAllTypeNamesFromRegistry().

{
   getAllTypeNamesFromRegistry(typeList);
}

initializeStateCache()

void ossimImageHandlerRegistry::initializeStateCache ( ) const

protected

Definition at line 546 of file ossimImageHandlerRegistry.cpp.

References ossimString::empty(), ossimPreferences::findPreference(), ossimPreferences::instance(), m_stateCache, ossimString::toBool(), and ossimString::toUInt32().

Referenced by ossimImageHandlerRegistry().

{
   m_stateCache = 0;
   ossimString enabledString = ossimPreferences::instance()->findPreference("ossim.imaging.handler.registry.state_cache.enabled");
   ossimString minSizeString = ossimPreferences::instance()->findPreference("ossim.imaging.handler.registry.state_cache.min_size");
   ossimString maxSizeString = ossimPreferences::instance()->findPreference("ossim.imaging.handler.registry.state_cache.max_size");

   ossim_uint32 maxSize = 0;
   ossim_uint32 minSize = 0;

   if(!enabledString.empty())
   {
      if(enabledString.toBool())
      {
         m_stateCache = std::make_shared<ossim::ItemCache<ossim::ImageHandlerState> >();
         if(!maxSizeString.empty())
         {
            maxSize = maxSizeString.toUInt32();
         }
         if(!minSizeString.empty())
         {
            minSize = minSizeString.toUInt32();
         }
         else if(maxSize)
         {
            minSize = ossim::round<ossim_uint32, ossim_float32>(maxSize*.8);
         }

         if(minSize < maxSize)
         {
            m_stateCache->setMinAndMaxItemsToCache(minSize, maxSize);
         }
      }

   }
}

instance()

ossimImageHandlerRegistry * ossimImageHandlerRegistry::instance ( )

static

Definition at line 41 of file ossimImageHandlerRegistry.cpp.

Referenced by ossimSingleImageChain::addImageHandler(), ossimPointObservation::addMeasurement(), ATP::AtpGenerator::constructChain(), demo1(), demo2(), demo3(), ossimShorelineTool::doThreshold(), ossimVerticesFinderTool::execute(), ossimImageCacheTileSource::fillTile(), ossimSubImageTool::initialize(), ossimInit::initializeDefaultFactories(), ossimEquationUtil::initInputSources(), ossimHdf5Tool::loadImageFiles(), main(), ossimBandSeparateHandler::open(), ossimGdalDataset::open(), ossimGeoidImage::open(), ossimImageElevationHandler::open(), ossimImageGeometry::open(), ossimInfo::openImageFromState(), ossimInfo::openImageHandler(), ossimImageHandlerFactory::openSrcRecord(), ossimImageHandlerRegistryGetInstance(), ossimplugins::ossimSharedLibraryFinalize(), ossimSharedLibraryFinalize(), ossimplugins::ossimSharedLibraryInitialize(), ossimSharedLibraryInitialize(), ossimTilingPoly::parseShpFile(), ossimInfo::printExtensions(), ossimInfo::printReaderProps(), ossimRpcSolver::solve(), ossimGpkgReader::uncompressPngTile(), ossimImageFileWriter::writeHistogramFile(), and ossimImageFileWriter::writeOverviewFile().

{
   static ossimImageHandlerRegistry sharedInstance;
   
   return &sharedInstance;
}

open() [1/4]

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

virtual

open that takes a filename.

Parameters

fileName	File to open.
trySuffixFirst	If true calls code to try to open by suffix first, then goes through the list of available handlers. default=true.
openOverview	If true image handler will attempt to open overview. default = true

Returns

Pointer to image handler or null if cannot open.

Definition at line 231 of file ossimImageHandlerRegistry.cpp.

Referenced by ossimSingleImageChain::addImageHandler(), ossimPointObservation::addMeasurement(), ATP::AtpGenerator::constructChain(), createObject(), demo1(), demo2(), demo3(), ossimShorelineTool::doThreshold(), ossimVerticesFinderTool::execute(), ossimImageCacheTileSource::fillTile(), ossimSubImageTool::initialize(), ossimEquationUtil::initInputSources(), ossimHdf5Tool::loadImageFiles(), main(), ossimBandSeparateHandler::open(), ossimGdalDataset::open(), ossimGeoidImage::open(), ossimImageElevationHandler::open(), ossimImageGeometry::open(), openBySuffix(), ossimInfo::openImageFromState(), ossimInfo::openImageHandler(), ossimTilingPoly::parseShpFile(), ossimRpcSolver::solve(), ossimGpkgReader::uncompressPngTile(), and ossimImageFileWriter::writeOverviewFile().

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(file, trySuffix,openOverview): entered.........." << std::endl;
   }
   std::shared_ptr<ossim::ImageHandlerState> state = getState(filename, 0);

   if(state)
   {
      ossimRefPtr<ossimImageHandler> h = open(state);
      if(h)
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(file, trySuffix,openOverview): returning with state open.........." << std::endl;;
         }
         return h.release();
      }
   }

   if(trySuffixFirst)
   {
      ossimRefPtr<ossimImageHandler> h = openBySuffix(filename, openOverview);
      if(h.valid())
      {
         addToStateCache(h.get());
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(file, trySuffix,openOverview): leaving.........." << std::endl;
         }
         return h.release();
      }
   }
   
   // now try magic number opens
   //
   ossimImageHandler*                   result = NULL;
   vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
   while((factory != m_factoryList.end()) && !result)
   {
      result = (*factory)->open(filename, openOverview);
      ++factory;
   }
 
   if(result)
   {
      addToStateCache(result);
   }  
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(file, trySuffix,openOverview): leaving.........." << std::endl;
   }
   return result;
}

open() [2/4]

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

virtual

Given a keyword list return a pointer to an ImageHandler.

Returns null if a valid handler cannot be found.

Definition at line 289 of file ossimImageHandlerRegistry.cpp.

References addToStateCache(), ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList, and ossimImageHandler::open().

{
   ossimImageHandler*                   result = NULL;
   vector<ossimImageHandlerFactoryBase*>::const_iterator factory;
   
   factory = m_factoryList.begin();
   while((factory != m_factoryList.end()) && !result)
   {
      result = (*factory)->open(kwl, prefix);
      ++factory;
   }

   if(result)
   {
      addToStateCache(result);
   }  
   
   return result;
}

open() [3/4]

ossimRefPtr< ossimImageHandler > ossimImageHandlerRegistry::open ( std::shared_ptr< ossim::ImageHandlerState >  state ) const

virtual

Definition at line 360 of file ossimImageHandlerRegistry.cpp.

References ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList.

{
   ossimRefPtr<ossimImageHandler> result = 0;
   vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(state): Entered......." << std::endl;
   }
   while( (!result)&&(factory != m_factoryList.end()) )
   {
      result = (*factory)->open( state );
      if ( result )
      {
         break;
      }
      ++factory;
   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(state): Leaving.......valid?" << result.valid()<<std::endl;
   }
   return result; 
}

open() [4/4]

ossimRefPtr< ossimImageHandler > ossimImageHandlerRegistry::open ( std::shared_ptr< ossim::istream > &  str, const std::string &  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 310 of file ossimImageHandlerRegistry.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(stream,connectionString,openOverview): entered.........." << std::endl;
   }
   ossimRefPtr<ossimImageHandler> result = 0;
   std::shared_ptr<ossim::ImageHandlerState> state = getState(connectionString, 0);
   
   if(state)
   {
      result = open(state);
      if(result)
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(stream,connectionString,openOverview): leaving with state open..........Valid? " 
                                               << result.valid() <<std::endl;
         }
         return result;
      }
   }
   if ( str )
   {
      vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
      while( factory != m_factoryList.end() )
      {
         result = (*factory)->open( str, connectionString, openOverview );
         if ( result.valid() )
         {
            break;
         }
         ++factory;
      }
   }
   if(result)
   {
      addToStateCache(result.get());
   }  
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::open(stream,connectionString,openOverview): leaving..........Valid? " 
                                         << result.valid()<<std::endl;
   }
   return result; 
}

openBySuffix()

ossimRefPtr< ossimImageHandler > ossimImageHandlerRegistry::openBySuffix ( const ossimFilename &  file, bool  openOverview = true  ) const

virtual

openBySuffix will call the mthod getImageHandlersBySuffix and go through each handler to try and open the file.

This should be a faster open for we do not have to do a magic number compare on all prior files and keep opening and closing files.

Parameters

openOverview

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

Definition at line 65 of file ossimImageHandlerRegistry.cpp.

References ossimFilename::ext(), getImageHandlersBySuffix(), open(), openOverview(), and size.

{
   std::vector<ossimRefPtr<ossimImageHandler> > handlers;
   
   getImageHandlersBySuffix(handlers, file.ext());
   ossim_uint32 idx = 0;
   ossim_uint32 size = (ossim_uint32) handlers.size();
   
   for(idx = 0; idx < size; ++idx)
   {
      handlers[idx]->setOpenOverviewFlag(openOverview);
      if(handlers[idx]->open(file))
      {
         return handlers[idx];
      }
   }
   
   return ossimRefPtr<ossimImageHandler>(0);
}

openConnection()

ossimRefPtr< ossimImageHandler > ossimImageHandlerRegistry::openConnection	(	const ossimString &	connectionString,
		bool	openOverview = true
	)		const

Definition at line 170 of file ossimImageHandlerRegistry.cpp.

Referenced by ossimSingleImageChain::addImageHandler().

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::openConnection: entered.........." << std::endl;
   }
   ossimRefPtr<ossimImageHandler> result(0);

   std::string myConnectionString = connectionString.downcase().string();
   std::string fileStr = "file://";
   std::size_t found = myConnectionString.find( fileStr );
   if ( found == 0 )
   {
      myConnectionString = connectionString.string().substr( fileStr.size() );
   }
   else
   {
      myConnectionString = connectionString.string();
   }
 
   // add entry 0
   std::shared_ptr<ossim::ImageHandlerState> state = getState(myConnectionString, 0);
   if(state)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::openConnection: leaving with open(state).........." << std::endl;;
      }
      return open(state);
   }  

   std::shared_ptr<ossim::istream> str = ossim::StreamFactoryRegistry::instance()->
      createIstream( myConnectionString, std::ios_base::in|std::ios_base::binary);

   if ( str )
   {
      result = open( str, myConnectionString, openOverview );
   }

   if ( !result.valid() )
   {
      ossimFilename f = myConnectionString;
      if ( f.exists() )
      {
         result = open( f, true, openOverview );
      }
   }

   if(result)
   {
      addToStateCache(result.get());
   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::openConnection: leaving.........." << std::endl;
   }
   
   return result;
}

openOverview()

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

virtual

Open overview that takes a file name.

This will only check readers that can be overview handlers.

Parameters

file	File to open.

Returns

ossimRefPtr to image handler on success or null on failure.

Definition at line 404 of file ossimImageHandlerRegistry.cpp.

Referenced by openBySuffix().

{
   ossimRefPtr<ossimImageHandler> result = 0;

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::openOverview: Entered......." << std::endl;
   }

   std::shared_ptr<ossim::ImageHandlerState> state = getState(file, 0);

   if(state)
   {
      result = open(state);

   }

   if(!result)
   {
      // See if we can open via the stream interface:
      std::shared_ptr<ossim::istream> str = ossim::StreamFactoryRegistry::instance()->
         createIstream( file, std::ios_base::in|std::ios_base::binary);
      
      if ( str )
      {
         std::vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
         while( factory != m_factoryList.end() )
         {
            result = (*factory)->openOverview( str, file );
            if ( result.valid() )
            {
               break;
            }
            ++factory;
         }

         str = 0;
      }

      if ( (result.valid() == false) && file.exists() )
      {  
         vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
         while( factory != m_factoryList.end() )
         {
            result = (*factory)->openOverview( file );
            if ( result.valid() )
            {
               break;
            }
            ++factory;
         }
      }

      if(result)
      {
         addToStateCache(result.get());
      }
   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimImageHandlerRegistry::openOverview: Leaving.......Valid? " 
                                         << result.valid() << std::endl;
   }
   return result;
}

operator=()

const ossimImageHandlerRegistry & ossimImageHandlerRegistry::operator= ( const ossimImageHandlerRegistry &  rhs )

protected

Definition at line 603 of file ossimImageHandlerRegistry.cpp.

{ return rhs; }

printReaderProps()

std::ostream & ossimImageHandlerRegistry::printReaderProps

(

std::ostream &

out

)

const

Prints list of readers and properties.

Parameters

out	Stream to print to.

Returns

std::ostream&

Definition at line 476 of file ossimImageHandlerRegistry.cpp.

References ossimRefPtr< T >::get(), ossimObject::getClassName(), ossimStringProperty::getConstraints(), ossimImageHandler::getProperty(), ossimImageHandler::getPropertyNames(), ossimFactoryListInterface< ossimImageHandlerFactoryBase, ossimImageHandler >::m_factoryList, and ossimRefPtr< T >::valid().

Referenced by ossimInfo::printReaderProps().

{
   // Loop through factories:
   vector<ossimImageHandlerFactoryBase*>::const_iterator factory = m_factoryList.begin();
   while( factory != m_factoryList.end() )
   {
      out << "factory: " << (*factory)->getClassName() << "\n";
      
      // Loop through factory image handlers:
      std::vector<ossimString> readerList;
      (*factory)->getTypeNameList(readerList);

      std::vector<ossimString>::const_iterator i = readerList.begin();
      while ( i != readerList.end() )
      {
         ossimRefPtr<ossimImageHandler> ih =
            dynamic_cast<ossimImageHandler*>( (*factory)->createObject( (*i) ) );
         if ( ih.valid() )
         {
            out << "reader: " << ih->getClassName() << "\n";

            // Loop through image handler properties:
            std::vector<ossimString> propNames;
            ih->getPropertyNames(propNames);
            if ( propNames.size() )
            {
               out << "\nproperties:\n";
               ossimRefPtr<ossimProperty> prop = 0;
               std::vector<ossimString>::const_iterator p = propNames.begin();
               while ( p != propNames.end() )
               {
                  out << "   " << (*p) << "\n";
                  prop = ih->getProperty( *p );
                  if ( prop.valid() )
                  {
                     ossimStringProperty* stringProp =
                        dynamic_cast<ossimStringProperty*>(prop.get());
                     if ( stringProp )
                     {
                        if ( stringProp->getConstraints().size() )
                        {
                           out << "      constraints:\n";
                           std::vector<ossimString>::const_iterator strPropIter =
                              stringProp->getConstraints().begin();
                           while( strPropIter != stringProp->getConstraints().end() )
                           {
                              out << "         " << (*strPropIter) << "\n";
                              ++strPropIter;
                           }
                        }
                     }
                  }
                  
                  ++p;
               }
               out << "\n";
            }
         }
         ++i;
      }
      ++factory;
   }
   out << std::endl;
   return out;
}

Member Data Documentation

m_stateCache

std::shared_ptr<ossim::ItemCache<ossim::ImageHandlerState> > ossimImageHandlerRegistry::m_stateCache

mutableprotected

Definition at line 187 of file ossimImageHandlerRegistry.h.

Referenced by addToStateCache(), getState(), and initializeStateCache().

---

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

• ossimImageHandlerRegistry.h
• ossimImageHandlerRegistry.cpp