ossimGeoidManager Class Reference

#include <ossimGeoidManager.h>

Inheritance diagram for ossimGeoidManager:

Public Member Functions
virtual	~ossimGeoidManager ()
virtual bool	open (const ossimFilename &dir, ossimByteOrder byteOrder)
	Permits initialization of geoids from directory name. More...
virtual double	offsetFromEllipsoid (const ossimGpt &gpt)
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of the object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of the object from a keyword list. More...
virtual void	addGeoid (ossimRefPtr< ossimGeoid > geoid, bool toFrontFlag=false)
	Permits adding additional geoids to the list: More...
ossimGeoid *	findGeoidByShortName (const ossimString &shortName, bool caseSensitive=true)
virtual void	clear ()
	Permits to clear the GeoidList. More...
Public Member Functions inherited from ossimGeoid
	ossimGeoid ()
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 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 ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Static Public Member Functions
static ossimGeoidManager *	instance ()
	Implements singelton pattern: More...

Private Member Functions
	ossimGeoidManager ()
	Private constructor. More...

Private Attributes
std::vector< ossimRefPtr< ossimGeoid > >	theGeoidList
ossimRefPtr< ossimGeoid >	theIdentityGeoid

Additional Inherited Members
Protected Member Functions inherited from ossimGeoid
virtual	~ossimGeoid ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Definition at line 26 of file ossimGeoidManager.h.

Constructor & Destructor Documentation

~ossimGeoidManager()

ossimGeoidManager::~ossimGeoidManager ( )

virtual

Definition at line 54 of file ossimGeoidManager.cpp.

References clear().

{
//    vector<ossimGeoid*>::iterator g = theGeoidList.begin();
//    while (g != theGeoidList.end())
//    {
//       delete *g;
//       ++g;
//    }
   clear();
}

ossimGeoidManager()

ossimGeoidManager::ossimGeoidManager ( )

private

Private constructor.

Use "instance" method.

Definition at line 44 of file ossimGeoidManager.cpp.

References theIdentityGeoid.

{
  // theInstance = this;
   theIdentityGeoid = new ossimIdentityGeoid();
}

Member Function Documentation

addGeoid()

void ossimGeoidManager::addGeoid ( ossimRefPtr< ossimGeoid >  geoid, bool  toFrontFlag = false  )

virtual

Permits adding additional geoids to the list:

Definition at line 94 of file ossimGeoidManager.cpp.

References theGeoidList.

{
   if(!toFrontFlag)
   {
      theGeoidList.push_back(geoid);
   }
   else
   {
      theGeoidList.insert(theGeoidList.begin(), geoid);
   }
}

clear()

void ossimGeoidManager::clear ( )

virtual

Permits to clear the GeoidList.

Definition at line 69 of file ossimGeoidManager.cpp.

References theGeoidList.

Referenced by ~ossimGeoidManager().

{
   theGeoidList.clear();
}

findGeoidByShortName()

ossimGeoid * ossimGeoidManager::findGeoidByShortName	(	const ossimString &	shortName,
		bool	caseSensitive = true
	)

Definition at line 328 of file ossimGeoidManager.cpp.

References ossimString::downcase(), ossimRefPtr< T >::get(), ossimObject::getShortName(), theGeoidList, and theIdentityGeoid.

Referenced by ossimElevationDatabase::loadState().

{
   ossim_uint32 idx=0;
   ossimString testString = shortName;
   if(shortName == "identity")
   {
      return theIdentityGeoid.get();
   }
   if(!caseSensitive)
   {
      testString  = testString.downcase();
   }
   for(idx = 0; idx < theGeoidList.size(); ++idx)
   {
      if(!caseSensitive)
      {
         if(theGeoidList[idx]->getShortName().downcase() == testString)
         {
            return theGeoidList[idx].get();
         }
      }
      else
      {
         if(theGeoidList[idx]->getShortName() == testString)
         {
            return theGeoidList[idx].get();
         }
      }
   }
   return 0;
}

instance()

ossimGeoidManager * ossimGeoidManager::instance ( )

static

Implements singelton pattern:

Definition at line 78 of file ossimGeoidManager.cpp.

Referenced by ossimElevRemapper::elevRemap(), ossimElevManager::getHeightAboveEllipsoid(), ossimElevManager::getHeightAboveMSL(), ossimElevationDatabase::getOffsetFromEllipsoid(), ossimGpt::heightMSL(), ossimElevationDatabase::loadState(), ossimIpodSensor::loadState(), ossimSkyBoxLearSensor::loadState(), ossimSonomaSensor::loadState(), and ossimInfo::outputHeight().

{
   static ossimGeoidManager inst;
//   if (!theInstance)
//   {
//      theInstance = new ossimGeoidManager();
//   }
   
   //return theInstance;
   return &inst;
}

loadState()

bool ossimGeoidManager::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Method to the load (recreate) the state of the object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 116 of file ossimGeoidManager.cpp.

{
   static const char MODULE[] = "ossimGeoidManager::loadState()";

   if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG: " << MODULE << ", entering...\n";

   //---
   // Look for geoid sources:
   // Note: the ossimInit::initializeElevation() does not pass a prefix to us
   // as it should...
   //---
   std::string geoidMgrPrefix = prefix ? prefix : "geoid.manager.";

   ossimString regExpression =  ossimString("^(") + geoidMgrPrefix.c_str() +
      "geoid_source[0-9]+.)";

   vector<ossimString> keys = kwl.getSubstringKeyList( regExpression );
   if ( keys.size() )
   {
      for ( ossim_uint32 idx = 0; idx < keys.size(); ++idx )
      {
         std::string newPrefix = keys[idx];

         // See if enable flag is set to false.
         bool enabled = true;
         std::string key = ossimKeywordNames::ENABLED_KW;
         std::string value = kwl.findKey( newPrefix, key );
         if ( value.size() )
         {
            enabled = ossimString( value ).toBool();
         }

         if ( enabled )
         {
            // Get the type:
            key = ossimKeywordNames::TYPE_KW;
            value = kwl.findKey( newPrefix, key );

            if ( (value == "geoid_image" ) || ( value == "ossimGeoidImage" ) )
            {
               ossimRefPtr<ossimGeoid> geoid = new ossimGeoidImage();
               if ( geoid->loadState( kwl, newPrefix.c_str() ) )
               {
                  if (traceDebug())
                  {
                     ossimNotify(ossimNotifyLevel_DEBUG)
                        << "DEBUG: " << MODULE
                        << "\nAdded geoid:  " << geoid->getShortName() << "\n";
                  }
                  addGeoid(geoid.get());
               }
            }
         }
      }
   }

   // End of "geoid_sources" block.
   
   // Look for the ngs geoid directories
   const char* lookup = kwl.find(prefix, "geoid_99_directory");
   ossimByteOrder geoidNgsByteOrder = OSSIM_LITTLE_ENDIAN;
   const char* byteOrder = kwl.find(prefix, "geoid_99_directory.byte_order");
   if (!lookup)
   {
      lookup = kwl.find(prefix, "geoid_ngs_directory");
      byteOrder = kwl.find(prefix, "geoid_ngs_directory.byte_order");
   }
   if(byteOrder)
   {
      if(ossimString(byteOrder).contains("little"))
      {
         geoidNgsByteOrder = OSSIM_LITTLE_ENDIAN;
      }
      else
      {
         geoidNgsByteOrder = OSSIM_BIG_ENDIAN;
      }
   }
   if(lookup)
   {
      ossimFilename f = lookup;
      if (f.isDir())
      {
         ossimRefPtr<ossimGeoid> geoid = new ossimGeoidNgs(f, geoidNgsByteOrder);

         if (geoid->getErrorStatus() == ossimErrorCodes::OSSIM_OK)
         {
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "DEBUG: " << MODULE
                  << "\nAdded geoid dir:  " << f.c_str() << "\n";
            }
            addGeoid(geoid.get());
         }
         else
         {
            geoid = 0;
         }
      }
   }

   ossimFilename geoidGrid1996 = ossimEnvironmentUtility::instance()->getUserOssimSupportDir();
   geoidGrid1996 = geoidGrid1996.dirCat("geoids");
   geoidGrid1996 = geoidGrid1996.dirCat("geoid1996");
   geoidGrid1996 = geoidGrid1996.dirCat("egm96.grd");

   if(!geoidGrid1996.exists())
   {
      geoidGrid1996 = ossimEnvironmentUtility::instance()->getInstalledOssimSupportDir();
      geoidGrid1996 = geoidGrid1996.dirCat("geoids");
      geoidGrid1996 = geoidGrid1996.dirCat("geoid1996");
      geoidGrid1996 = geoidGrid1996.dirCat("egm96.grd");
   }

   if( geoidGrid1996.exists() )
   {
      ossimRefPtr<ossimGeoid> geoid = new ossimGeoidEgm96(geoidGrid1996);
      if (geoid->getErrorStatus() == ossimErrorCodes::OSSIM_OK)
      {
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "DEBUG: " << MODULE
               << "\nAdded geoid egm 96:  " << geoidGrid1996.c_str()
               << "\n";
         }
         addGeoid(geoid.get());
      }
      else
      {
         geoid = 0;
      }
   }
   else
   {
      // Look for the geoid Earth Gravity Model (EGM) 96 directory.
      lookup = kwl.find(prefix, "geoid_egm_96_grid");
      if (lookup)
      {
         ossimFilename f = lookup;
         if (f.isDir() || f.isFile())
         {
            ossimRefPtr<ossimGeoid> geoid = new ossimGeoidEgm96(f);
            
            if (geoid->getErrorStatus() == ossimErrorCodes::OSSIM_OK)
            {
               if (traceDebug())
               {
                  ossimNotify(ossimNotifyLevel_DEBUG)
                     << "DEBUG: " << MODULE
                     << "\nAdded geoid egm 96:  " << f.c_str()
                     << "\n";
               }
               
               addGeoid(geoid.get());
            }
            else
            {
               geoid = 0;
            }
         }
      }
   }
   if (traceExec())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG: " << MODULE << ", returning...\n";
   }
   
   return true;
}

offsetFromEllipsoid()

double ossimGeoidManager::offsetFromEllipsoid ( const ossimGpt &  gpt )

virtual

Returns

The offset from the ellipsoid to the geoid or ossim::nan() if grid does not contain the point.

Implements ossimGeoid.

Definition at line 313 of file ossimGeoidManager.cpp.

References ossim::isnan(), ossim::nan(), and theGeoidList.

Referenced by ossimElevRemapper::elevRemap(), ossimElevManager::getHeightAboveEllipsoid(), ossimElevManager::getHeightAboveMSL(), ossimElevationDatabase::getOffsetFromEllipsoid(), ossimGpt::heightMSL(), ossimIpodSensor::loadState(), ossimSkyBoxLearSensor::loadState(), ossimSonomaSensor::loadState(), and ossimInfo::outputHeight().

{
   double offset = ossim::nan();
   std::vector<ossimRefPtr<ossimGeoid> >::iterator geoid =
      theGeoidList.begin();
   
   while ( ossim::isnan(offset) && (geoid != theGeoidList.end()))
   {
      offset = ((*geoid))->offsetFromEllipsoid(gpt);
      ++geoid;
   }
   
   return offset;
}

open()

bool ossimGeoidManager::open ( const ossimFilename &  dir, ossimByteOrder  byteOrder  )

virtual

Permits initialization of geoids from directory name.

Should never be called since called on specific geoid types:

Implements ossimGeoid.

Definition at line 296 of file ossimGeoidManager.cpp.

References ossim::byteOrder(), status, and theGeoidList.

{
   std::vector<ossimRefPtr<ossimGeoid> >::iterator g = theGeoidList.begin();
   bool status = true;
   while (g != theGeoidList.end())
   {
      status &= (*g)->open(dir, byteOrder);
      ++g;
   }

   return status;
}

saveState()

bool ossimGeoidManager::saveState ( ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Method to save the state of the object to a keyword list.

Return true if ok or false on error. DO NOTHING

Reimplemented from ossimObject.

Definition at line 106 of file ossimGeoidManager.cpp.

{
   return true;
}

Member Data Documentation

theGeoidList

std::vector< ossimRefPtr<ossimGeoid> > ossimGeoidManager::theGeoidList

mutableprivate

Definition at line 84 of file ossimGeoidManager.h.

Referenced by addGeoid(), clear(), findGeoidByShortName(), offsetFromEllipsoid(), and open().

theIdentityGeoid

ossimRefPtr<ossimGeoid> ossimGeoidManager::theIdentityGeoid

private

Definition at line 88 of file ossimGeoidManager.h.

Referenced by findGeoidByShortName(), and ossimGeoidManager().

---

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

• ossimGeoidManager.h
• ossimGeoidManager.cpp