ossimElevationDatabaseFactory Class Reference

This is our default elevation factory in the ossim core. More...

#include <ossimElevationDatabaseFactory.h>

Inheritance diagram for ossimElevationDatabaseFactory:

Public Member Functions
	ossimElevationDatabaseFactory ()
ossimElevationDatabase *	createDatabase (const ossimString &typeName) const
ossimElevationDatabase *	createDatabase (const ossimKeywordlist &kwl, const char *prefix=0) const
virtual ossimElevationDatabase *	open (const ossimString &connectionString) const
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
Public Member Functions inherited from ossimElevationDatabaseFactoryBase
virtual ossimObject *	createObject (const ossimString &typeName) const
	Creates an object given a type name. More...
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
	Creates and object given a keyword list. 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 ossimElevationDatabaseFactory *	instance ()

Static Protected Attributes
static ossimElevationDatabaseFactory *	m_instance = 0

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

This is our default elevation factory in the ossim core.

It supports general_raster, general imagery, DTED and SRTM directory layouts.

Example DTED Keywordlist:

elevation_manager.elevation_source1.type: dted_directory
elevation_manager.elevation_source1.connection_string: /data/elevation/dted/level0
elevation_manager.elevation_source1.min_open_cells: 5
elevation_manager.elevation_source1.max_open_cells: 25
elevation_manager.elevation_source1.enabled: true
elevation_manager.elevation_source1.memory_map_cells: true

Note: only use memory_map_cells to true if they are small files. DTED0 is small so we set it to true. Where the dted file tree has the form: <rootdir>/w056/n49.dt0

Example General Raster directory:

elevation_manager.elevation_source2.type: general_raster_directory
elevation_manager.elevation_source2.connection_string: /data/tutorial/data/elevation/general_raster_pk_90m
elevation_manager.elevation_source2.min_open_cells: 25
elevation_manager.elevation_source2.max_open_cells: 50 
elevation_manager.elevation_source2.enabled: false 
elevation_manager.elevation_source2.memory_map_cells: false

where the directory is a flat directory with general raster files

Example SRTM directory:

elevation_manager.elevation_source10.type: srtm_directory
elevation_manager.elevation_source10.connection_string: /Volumes/DataDrive/data/elevation/srtm1/
elevation_manager.elevation_source10.min_open_cells: 25
elevation_manager.elevation_source10.max_open_cells: 50 
elevation_manager.elevation_source10.memory_map_cells: false
elevation_manager.elevation_source10.enabled: true

where the directory has files of the form N39W112.hgt and are 1x1 degree cells

Example image directory format:

elevation_manager.elevation_source20.type: image_directory
elevation_manager.elevation_source20.connection_string: /data/elevation/image
elevation_manager.elevation_source20.min_open_cells: 25
elevation_manager.elevation_source20.max_open_cells: 50 
elevation_manager.elevation_source20.memory_map_cells: false
elevation_manager.elevation_source20.enabled: false 

where the directory can have any image the ossim supports and is a flat directory

Definition at line 57 of file ossimElevationDatabaseFactory.h.

Constructor & Destructor Documentation

ossimElevationDatabaseFactory()

ossimElevationDatabaseFactory::ossimElevationDatabaseFactory ( )

inline

Definition at line 60 of file ossimElevationDatabaseFactory.h.

Referenced by instance().

   {
      m_instance = this;
   }

Member Function Documentation

createDatabase() [1/2]

ossimElevationDatabase * ossimElevationDatabaseFactory::createDatabase ( const ossimString &  typeName ) const

virtual

Parameters

typeName

is the type name of the database you wish to create.

Returns

the elevation database or null otherwise

Implements ossimElevationDatabaseFactoryBase.

Definition at line 20 of file ossimElevationDatabaseFactory.cpp.

References STATIC_TYPE_NAME.

Referenced by createDatabase().

{
   if((typeName == STATIC_TYPE_NAME(ossimDtedElevationDatabase)) ||
      (typeName == "dted")||
      (typeName == "dted_directory"))
      
   {
      return new ossimDtedElevationDatabase();
   }
   else if((typeName == STATIC_TYPE_NAME(ossimSrtmElevationDatabase)) ||
           (typeName == "srtm")||
           (typeName == "srtm_directory"))
      
   {
      return new ossimSrtmElevationDatabase();
   }
   else if((typeName == STATIC_TYPE_NAME(ossimGeneralRasterElevationDatabase)) ||
           (typeName == "general_raster")||
           (typeName == "general_raster_directory"))
      
   {
      return new ossimGeneralRasterElevationDatabase();
   }
   else if( (typeName == "ossimImageElevationDatabase") ||
            (typeName == "image_directory"))
      
   {
      return new ossimImageElevationDatabase();
   }
   
   return 0;
}

createDatabase() [2/2]

ossimElevationDatabase * ossimElevationDatabaseFactory::createDatabase ( const ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Parameters

kwl	kewyord list that has state information about how to create a database
prefix	prefix key to use when loading the state information.

Returns

the elevation database or null otherwise

Implements ossimElevationDatabaseFactoryBase.

Definition at line 53 of file ossimElevationDatabaseFactory.cpp.

References createDatabase(), ossimString::empty(), ossimKeywordlist::find(), ossimElevationDatabase::loadState(), ossimRefPtr< T >::release(), ossimKeywordNames::TYPE_KW, and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimElevationDatabase> result = 0;
   ossimString type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
   if(!type.empty())
   {
      result = createDatabase(type);
      if(result.valid())
      {
         if(!result->loadState(kwl, prefix))
         {
            result = 0;
         }
      }
   }
   
   return result.release();
}

getTypeNameList()

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

virtual

Parameters

typeList

appends to the typeList all the type names this factory supports

Implements ossimObjectFactory.

Definition at line 106 of file ossimElevationDatabaseFactory.cpp.

References STATIC_TYPE_NAME.

{
   typeList.push_back(STATIC_TYPE_NAME(ossimDtedElevationDatabase));
   typeList.push_back(STATIC_TYPE_NAME(ossimSrtmElevationDatabase));
   typeList.push_back(STATIC_TYPE_NAME(ossimGeneralRasterElevationDatabase));
   typeList.push_back(STATIC_TYPE_NAME(ossimImageElevationDatabase));
}

instance()

ossimElevationDatabaseFactory * ossimElevationDatabaseFactory::instance ( )

static

Returns

a singleton instance of this factory

Definition at line 10 of file ossimElevationDatabaseFactory.cpp.

References m_instance, and ossimElevationDatabaseFactory().

Referenced by ossimElevationDatabaseRegistry::instance().

{
   if(!m_instance)
   {
      m_instance = new ossimElevationDatabaseFactory();
   }
   
   return m_instance;
}

open()

ossimElevationDatabase * ossimElevationDatabaseFactory::open ( const ossimString &  connectionString ) const

virtual

Parameters

connectionString

used to determine which database can support that connection.

Returns

the elevation database or null otherwise

Implements ossimElevationDatabaseFactoryBase.

Definition at line 73 of file ossimElevationDatabaseFactory.cpp.

References ossimFilename::isFile(), ossimElevationDatabase::open(), and ossimRefPtr< T >::release().

{
   ossimRefPtr<ossimElevationDatabase> result = 0;
   do
   {
      result = new ossimDtedElevationDatabase();
      if (result->open(connectionString))
         break;

      result = new ossimSrtmElevationDatabase;
      if (result->open(connectionString))
         break;

      result = new ossimGeneralRasterElevationDatabase;
      if (result->open(connectionString))
         break;

      // This method will only open individual image files for use as dems. It will not utilize the
      // file walker to search over directories:
      ossimFilename filename (connectionString);
      if (filename.isFile())
      {
         result = new ossimImageElevationDatabase;
         if (result->open(connectionString))
            break;
      }

      result = 0;
   } while (0);

   return result.release();
}

Member Data Documentation

m_instance

ossimElevationDatabaseFactory * ossimElevationDatabaseFactory::m_instance = 0

staticprotected

Definition at line 99 of file ossimElevationDatabaseFactory.h.

Referenced by instance().

---

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

• ossimElevationDatabaseFactory.h
• ossimElevationDatabaseFactory.cpp