ossimEnvironmentUtility Class Reference

#include <ossimEnvironmentUtility.h>

Public Types
typedef std::vector< ossimFilename >	FilenameListType

Public Member Functions
ossimString	getEnvironmentVariable (const ossimString &variable) const
void	setEnvironmentVariable (const char *variable, const char *value) const
ossimFilename	getUserDir () const
ossimString	getUserName () const
ossimFilename	getUserOssimSupportDir () const
ossimFilename	getUserOssimPreferences () const
ossimFilename	getUserOssimPluginDir () const
ossimFilename	getInstalledOssimSupportDir () const
ossimFilename	getInstalledOssimPluginDir () const
ossimFilename	getInstalledOssimPreferences () const
ossimFilename	getCurrentWorkingDir () const
ossimFilename	searchAllPaths (const ossimFilename &file) const
ossimFilename	findPlugin (const ossimFilename &plugin) const
ossimFilename	findData (const ossimFilename &data) const
void	addDataSearchPath (const ossimFilename &path)
void	addDataSearchPathToFront (const ossimFilename &path)
void	addPluginSearchPath (const ossimFilename &path)
void	addPluginSearchPathToFront (const ossimFilename &path)
ossimEnvironmentUtility::FilenameListType &	getPluginSearchPath ()
const ossimEnvironmentUtility::FilenameListType &	getPluginSearchPath () const
ossimEnvironmentUtility::FilenameListType &	getDataSearchPath ()
const ossimEnvironmentUtility::FilenameListType &	getDataSearchPath () const

Static Public Member Functions
static ossimEnvironmentUtility *	instance ()

Private Member Functions
	ossimEnvironmentUtility ()
	ossimEnvironmentUtility (const ossimEnvironmentUtility &obj)
const ossimEnvironmentUtility &	operator= (const ossimEnvironmentUtility &rhs)

Private Attributes
ossimEnvironmentUtility::FilenameListType	thePluginSearchPath
ossimEnvironmentUtility::FilenameListType	theDataSearchPath

Static Private Attributes
static ossimEnvironmentUtility *	theInstance =0

Detailed Description

Definition at line 6 of file ossimEnvironmentUtility.h.

Member Typedef Documentation

FilenameListType

typedef std::vector<ossimFilename> ossimEnvironmentUtility::FilenameListType

Definition at line 9 of file ossimEnvironmentUtility.h.

Constructor & Destructor Documentation

ossimEnvironmentUtility() [1/2]

ossimEnvironmentUtility::ossimEnvironmentUtility ( )

private

Definition at line 16 of file ossimEnvironmentUtility.cpp.

References ossimString::empty().

{
   ossimFilename dir = getUserOssimPluginDir();
   
   if(!dir.empty())
   {
      thePluginSearchPath.push_back(dir);
   }
   
   dir = getInstalledOssimPluginDir();
   if(!dir.empty())
   {   
      thePluginSearchPath.push_back(dir);
   }

   
}

ossimEnvironmentUtility() [2/2]

ossimEnvironmentUtility::ossimEnvironmentUtility ( const ossimEnvironmentUtility &  obj )

private

Definition at line 308 of file ossimEnvironmentUtility.cpp.

{
}

Member Function Documentation

addDataSearchPath()

void ossimEnvironmentUtility::addDataSearchPath

(

const ossimFilename &

path

)

Definition at line 234 of file ossimEnvironmentUtility.cpp.

{
   theDataSearchPath.push_back(path);
}

addDataSearchPathToFront()

void ossimEnvironmentUtility::addDataSearchPathToFront

(

const ossimFilename &

path

)

Definition at line 239 of file ossimEnvironmentUtility.cpp.

{
   theDataSearchPath.insert(theDataSearchPath.begin(), path);
}

addPluginSearchPath()

void ossimEnvironmentUtility::addPluginSearchPath

(

const ossimFilename &

path

)

Definition at line 244 of file ossimEnvironmentUtility.cpp.

{
   thePluginSearchPath.push_back(path);
}

addPluginSearchPathToFront()

void ossimEnvironmentUtility::addPluginSearchPathToFront

(

const ossimFilename &

path

)

Definition at line 249 of file ossimEnvironmentUtility.cpp.

{
   thePluginSearchPath.insert(thePluginSearchPath.begin(), path);
}

findData()

ossimFilename ossimEnvironmentUtility::findData

(

const ossimFilename &

data

)

const

Definition at line 270 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat(), and ossimFilename::exists().

{
   for(ossimEnvironmentUtility::FilenameListType::const_iterator iter = theDataSearchPath.begin();
       iter != theDataSearchPath.end();
       ++iter)
   {
      ossimFilename temp = iter->dirCat(data);
      if(temp.exists())
      {
         return temp;
      }
   }

   return "";
}

findPlugin()

ossimFilename ossimEnvironmentUtility::findPlugin

(

const ossimFilename &

plugin

)

const

Definition at line 254 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat(), and ossimFilename::exists().

{
   for(ossimEnvironmentUtility::FilenameListType::const_iterator iter = thePluginSearchPath.begin();
       iter != thePluginSearchPath.end();
       ++iter)
   {
      ossimFilename temp = iter->dirCat(plugin);
      if(temp.exists())
      {
         return temp;
      }
   }

   return "";
}

getCurrentWorkingDir()

ossimFilename ossimEnvironmentUtility::getCurrentWorkingDir

(

)

const

Returns

The current working dir which is /home/dburken/code/ossimlabs/ossim/doc for unix for windows.

Definition at line 206 of file ossimEnvironmentUtility.cpp.

Referenced by ossimBatchTest::execute(), and ossimplugins::ossimTerraSarModel::findTSXLeader().

{
   ossimFilename result;

#if OSSIM_ENVIRONMENT_UTILITY_UNIX
   result = getEnvironmentVariable("PWD");
#else
   char buf[512];
   _getcwd(buf, 512);
   result = buf;
#endif

   return result;
}

getDataSearchPath() [1/2]

ossimEnvironmentUtility::FilenameListType & ossimEnvironmentUtility::getDataSearchPath

(

)

Definition at line 297 of file ossimEnvironmentUtility.cpp.

{
   return theDataSearchPath;
}

getDataSearchPath() [2/2]

const ossimEnvironmentUtility::FilenameListType & ossimEnvironmentUtility::getDataSearchPath

(

)

const

Definition at line 302 of file ossimEnvironmentUtility.cpp.

{
   return theDataSearchPath;
}

getEnvironmentVariable()

ossimString ossimEnvironmentUtility::getEnvironmentVariable

(

const ossimString &

variable

)

const

Definition at line 44 of file ossimEnvironmentUtility.cpp.

References variable.

Referenced by ossimBatchTest::doDefaultClean(), ossimBatchTest::execute(), ossimTempFilename::generate(), ossimBatchTest::getDefaultTempFileDir(), and ossimElevManager::loadStandardElevationPaths().

{
   ossimString result;
   char* lookup = std::getenv(variable.c_str());
   // getenv returns NULL if not found.
   if (lookup)
   {
      result = (const char*)lookup;
   }
   return result;
}

getInstalledOssimPluginDir()

ossimFilename ossimEnvironmentUtility::getInstalledOssimPluginDir

(

)

const

Definition at line 160 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat(), and ossimFilename::exists().

{
   ossimFilename result = getInstalledOssimSupportDir();

   //Need generic unix plugin location
#if OSSIM_ENVIRONMENT_UTILITY_UNIX
#   ifndef __APPLE__
   return "";
#   endif
#endif
   if((result!="")&&result.exists())
   {
      result = result.dirCat("plugins");
   }
   else
   {
      result = "";
   }

   return result;

}

getInstalledOssimPreferences()

ossimFilename ossimEnvironmentUtility::getInstalledOssimPreferences

(

)

const

Definition at line 183 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat(), and ossimFilename::exists().

{
   ossimFilename result = getInstalledOssimSupportDir();

   
   if((result!="")&&result.exists())
   {
      result = result.dirCat("preferences");
   }
   else
   {
      result = "";
   }

   if(!result.exists())
   {
      result = "";
   }
   
   return result;
   
}

getInstalledOssimSupportDir()

ossimFilename ossimEnvironmentUtility::getInstalledOssimSupportDir

(

)

const

Definition at line 133 of file ossimEnvironmentUtility.cpp.

References ossimFilename::exists().

Referenced by ossimElevManager::loadStandardElevationPaths().

{
   ossimFilename result;
#if OSSIM_ENVIRONMENT_UTILITY_UNIX
#   ifdef __APPLE__
   result = "/Library/Application Support/ossim";
#   else
   result = "/usr/share/ossim";
   if(!result.exists())
   {
      result = "/usr/local/share/ossim";
   }
#   endif
#else
   // NEED the windows test here.
#endif
   if(result != "")
   {
      if(!result.exists())
      {
         result = "";
      }
   }

   return result;
}

getPluginSearchPath() [1/2]

ossimEnvironmentUtility::FilenameListType & ossimEnvironmentUtility::getPluginSearchPath

(

)

Definition at line 287 of file ossimEnvironmentUtility.cpp.

{
   return thePluginSearchPath;
}

getPluginSearchPath() [2/2]

const ossimEnvironmentUtility::FilenameListType & ossimEnvironmentUtility::getPluginSearchPath

(

)

const

Definition at line 292 of file ossimEnvironmentUtility.cpp.

{
   return thePluginSearchPath;
}

getUserDir()

ossimFilename ossimEnvironmentUtility::getUserDir

(

)

const

Definition at line 94 of file ossimEnvironmentUtility.cpp.

Referenced by ossimFilename::expand().

{
   ossimFilename result;

#if OSSIM_ENVIRONMENT_UTILITY_UNIX
   result = ossimFilename(getEnvironmentVariable("HOME"));
#else
   result =ossimFilename(getEnvironmentVariable("USERPROFILE"));
#endif

   return result;
}

getUserName()

ossimString ossimEnvironmentUtility::getUserName

(

)

const

Definition at line 85 of file ossimEnvironmentUtility.cpp.

{
#if OSSIM_ENVIRONMENT_UTILITY_UNIX
   return getEnvironmentVariable("USER");
#else
   return getEnvironmentVariable("USERNAME");
#endif
}

getUserOssimPluginDir()

ossimFilename ossimEnvironmentUtility::getUserOssimPluginDir

(

)

const

Definition at line 121 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat().

Referenced by ossimInit::initializePlugins().

{
   ossimFilename result = getUserOssimSupportDir();

   if(result != "")
   {
      result = result.dirCat("plugins");
   }
   
   return result;
}

getUserOssimPreferences()

ossimFilename ossimEnvironmentUtility::getUserOssimPreferences

(

)

const

Definition at line 107 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat().

{
   ossimFilename result = getUserOssimSupportDir();

   if(result == "")
   {
      return "";
   }

   result = result.dirCat("preferences");
   
   return result;
}

getUserOssimSupportDir()

ossimFilename ossimEnvironmentUtility::getUserOssimSupportDir

(

)

const

Definition at line 67 of file ossimEnvironmentUtility.cpp.

References ossimFilename::dirCat().

Referenced by ossimElevManager::loadStandardElevationPaths().

{
   ossimFilename result = getUserDir();
   
#if OSSIM_ENVIRONMENT_UTILITY_UNIX
#   ifdef __APPLE__
   result = result.dirCat("Library/Application Support/ossim");
   
#   else
   result = result.dirCat(".ossim");
#   endif
#else
   result = result.dirCat("Application Data\\ossim");
#endif
   
   return result;
}

instance()

ossimEnvironmentUtility * ossimEnvironmentUtility::instance ( )

static

Definition at line 34 of file ossimEnvironmentUtility.cpp.

Referenced by ossimBatchTest::doDefaultClean(), ossimBatchTest::execute(), ossimFilename::expand(), ossimplugins::ossimTerraSarModel::findTSXLeader(), ossimTempFilename::generate(), ossimBatchTest::getDefaultTempFileDir(), ossimInit::initializePlugins(), ossimElevManager::loadStandardElevationPaths(), and ossimInit::parseEnvOptions().

{
   if(!theInstance)
   {
      theInstance = new ossimEnvironmentUtility;
   }

   return theInstance;
}

operator=()

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

private

Definition at line 314 of file ossimEnvironmentUtility.cpp.

{
   return *this;
}

searchAllPaths()

ossimFilename ossimEnvironmentUtility::searchAllPaths

(

const ossimFilename &

file

)

const

Definition at line 221 of file ossimEnvironmentUtility.cpp.

References ossimString::empty().

{
   ossimFilename result;

   result = findPlugin(file);
   if(!result.empty()) return result;

   result = findData(file);


   return result;
}

setEnvironmentVariable()

void ossimEnvironmentUtility::setEnvironmentVariable	(	const char *	variable,
		const char *	value
	)		const

Definition at line 56 of file ossimEnvironmentUtility.cpp.

References variable.

Referenced by ossimBatchTest::execute(), and ossimInit::parseEnvOptions().

{
#if OSSIM_ENVIRONMENT_UTILITY_UNIX
   setenv(variable,  value,    1); // For backwards compatiblity.
#else
   ostringstream arg;
   arg<<variable<<"="<<value;
   _putenv( arg.str().c_str() );
#endif
}

Member Data Documentation

theDataSearchPath

ossimEnvironmentUtility::FilenameListType ossimEnvironmentUtility::theDataSearchPath

private

Definition at line 52 of file ossimEnvironmentUtility.h.

theInstance

ossimEnvironmentUtility * ossimEnvironmentUtility::theInstance =0

staticprivate

Definition at line 49 of file ossimEnvironmentUtility.h.

thePluginSearchPath

ossimEnvironmentUtility::FilenameListType ossimEnvironmentUtility::thePluginSearchPath

private

Definition at line 51 of file ossimEnvironmentUtility.h.

---

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

• ossimEnvironmentUtility.h
• ossimEnvironmentUtility.cpp