ossimInit Class Reference

#include <ossimInit.h>

Public Member Functions
	~ossimInit ()
void	addOptions (ossimArgumentParser &parser)
void	initialize (int &argc, char **argv)
void	initialize (ossimArgumentParser &parser)
void	initialize ()
void	finalize ()
void	usage ()
bool	getElevEnabledFlag () const
void	setElevEnabledFlag (bool flag)
	Sets theElevEnabledFlag. More...
void	setPluginLoaderEnabledFlag (bool flag)
void	loadPlugins (const ossimFilename &plugin, const char *options=0)
	Can take a file or a directory. More...
void	initializePlugins ()
void	initializeDefaultFactories ()
void	initializeElevation ()
void	initializeLogFile ()
	Initializes log file from preferences keyword lookup of "ossim.log.file" if log file has not already been set and keyword is set in preferences. More...
ossimString	version () const
ossimFilename	appName () const

Static Public Member Functions
static ossimInit *	instance ()

Protected Member Functions
	ossimInit ()
	protected default constructor. More...
	ossimInit (const ossimInit &obj)
	Hidden from use copy constructor. More...
void	operator= (const ossimInit &rhs) const
	Hidden from use assignment operator. More...
void	parseOptions (ossimArgumentParser &parser)
void	parseNotifyOption (ossimArgumentParser &parser)
void	parseEnvOptions (ossimArgumentParser &parser)
void	parsePrefsOptions (ossimArgumentParser &parser)
void	removeOption (int &argc, char **argv, int argToRemove)

Protected Attributes
bool	theInitializedFlag
ossimFilename	theAppName
ossimPreferences *	thePreferences
bool	theElevEnabledFlag
bool	thePluginLoaderEnabledFlag

Static Protected Attributes
static ossimInit *	theInstance = 0

Detailed Description

Definition at line 29 of file ossimInit.h.

Constructor & Destructor Documentation

~ossimInit()

ossimInit::~ossimInit

(

)

Definition at line 74 of file ossimInit.cpp.

References theInstance.

{
   theInstance = 0;
}

ossimInit() [1/2]

ossimInit::ossimInit ( )

protected

protected default constructor.

Definition at line 79 of file ossimInit.cpp.

Referenced by instance().

    :
       theInitializedFlag(false),
       theAppName(),
       thePreferences(0), // Delay instance() call until stream factory init.
       theElevEnabledFlag(true),
       thePluginLoaderEnabledFlag(true)
{
}

ossimInit() [2/2]

ossimInit::ossimInit ( const ossimInit &  obj )

protected

Hidden from use copy constructor.

Definition at line 930 of file ossimInit.cpp.

:  theInitializedFlag(false),
   theAppName(),
   thePreferences(ossimPreferences::instance()),
   theElevEnabledFlag(true),
   thePluginLoaderEnabledFlag(true)
{}       

Member Function Documentation

addOptions()

void ossimInit::addOptions

(

ossimArgumentParser &

parser

)

Definition at line 100 of file ossimInit.cpp.

References ossimApplicationUsage::addCommandLineOption(), and ossimArgumentParser::getApplicationUsage().

Referenced by main(), ossimHillshadeTool::setUsage(), ossimInfo::setUsage(), ossimChipProcTool::setUsage(), ossimTool::setUsage(), ossimPointCloudTool::usage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), and ossimChipperUtil::usage().

{
   parser.getApplicationUsage()->addCommandLineOption("--env", "Specify an env variable to set.  Any number of these can appear with format --env VARIABLE=VALUE");
   parser.getApplicationUsage()->addCommandLineOption("-P", "specify a preference file to load");
   parser.getApplicationUsage()->addCommandLineOption("-K", "specify individual keywords to add to the preferences keyword list: name=value");
   parser.getApplicationUsage()->addCommandLineOption("-T", "specify the classes to trace, ex: ossimInit|ossimImage.* \nwill trace ossimInit and all ossimImage classes");
   parser.getApplicationUsage()->addCommandLineOption("--disable-elev", "Will disable the elevation");
   parser.getApplicationUsage()->addCommandLineOption("--disable-plugin", "Will disable the plugin loader");
   
   parser.getApplicationUsage()->addCommandLineOption("--ossim-logfile", "takes a logfile as an argument.  All output messages are redirected to the specified log file.  By default there is no log file and all messages are enabled.");
   parser.getApplicationUsage()->addCommandLineOption("--disable-notify", "Takes an argument. Arguments are ALL, WARN, NOTICE, INFO, FATAL, DEBUG.  If you want multiple disables then just do multiple --disable-notify on the command line.  All argument are case insensitive.  Default is all are enabled.");
}

appName()

ossimFilename ossimInit::appName

(

)

const

Definition at line 925 of file ossimInit.cpp.

References theAppName.

{
   return theAppName;
}

finalize()

void ossimInit::finalize

(

)

Definition at line 261 of file ossimInit.cpp.

Referenced by main().

{
   
}

getElevEnabledFlag()

bool ossimInit::getElevEnabledFlag

(

)

const

Returns

theElevEnabledFlag

Definition at line 290 of file ossimInit.cpp.

References theElevEnabledFlag.

{
   return theElevEnabledFlag;
}

initialize() [1/3]

void ossimInit::initialize	(	int &	argc,
		char **	argv
	)

METHOD: initialize() This method shall be called from the application's main module with the command-line arguments. Every OSSIM application should have the following line early in the main module:

ossimInit::initialize(argc, argv);

OR

ossimInit::instance()->initialize(argc, argv);

The two forms are functionally identical. Pick the latter form if you like to type. The argv command line options are parsed and may be stripped. the value of argc will be adjusted to account for stripped options.

---

METHOD: ossimInit::initialize()

Method called from the OSSIM application main.

Definition at line 119 of file ossimInit.cpp.

References initialize(), theInitializedFlag, and theInstance.

Referenced by initialize(), and main().

{
   static std::mutex m;
   std::lock_guard<std::mutex> lock(m);
   if( !theInitializedFlag )
   {
      ossimArgumentParser argumentParser(&argc, argv);
      theInstance->initialize(argumentParser);
   }
}

initialize() [2/3]

void ossimInit::initialize

(

ossimArgumentParser &

parser

)

Definition at line 130 of file ossimInit.cpp.

References theInitializedFlag.

{
   static std::mutex m;
   std::lock_guard<std::mutex> lock(m);
   if(theInitializedFlag)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "DEBUG ossimInit::initialize(parser):"
            << " Already initialized, returning......"
            << std::endl;
      }
      return;
   }
   theInstance->parseEnvOptions(parser);
   theInstance->parseNotifyOption(parser);
   theInstance->parsePrefsOptions(parser);

   theInstance->theAppName  = parser.getApplicationUsage()->getApplicationName();

   //Parse the command line:

   theInstance->parseOptions(parser);
   // we will also support defining a trace pattern from an Environment
   // variable.  This will make JNI code easier to enable tracing
   //
   ossimString traceVariable = ossimEnvironmentUtility::instance()->getEnvironmentVariable("OSSIM_TRACE");

   if(!traceVariable.empty())
   {
      ossimTraceManager::instance()->setTracePattern(traceVariable);
   }

   theInstance->initializeDefaultFactories();

   if ( theElevEnabledFlag )
   {
      theInstance->initializeElevation();
   }

   theInstance->initializeLogFile();
   
   if(thePluginLoaderEnabledFlag)
   {
      theInstance->initializePlugins();
   }
   
   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossim preferences file: "
         << theInstance->thePreferences->getPreferencesFilename()
         << "\nVersion: " << version()
         << "\nossimInit::initialize(parser): leaving..." << std::endl;
   }
   
   theInitializedFlag = true;
}

initialize() [3/3]

void ossimInit::initialize

(

)

Definition at line 190 of file ossimInit.cpp.

References theInitializedFlag.

{
   if(theInitializedFlag)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "DEBUG ossimInit::initialize(parser):"
            << " Already initialized, returning......"
            << std::endl;
      }
      return;
   }
   
   int argc = 1;
   char* argv[1];

   argv[0] = new char[1];
   argv[0][0] = '\0';
   initialize(argc, argv);
   delete [] argv[0];

#if 0   
    static std::mutex m;
   std::lock_guard<std::mutex> lock(m);
   if(theInitializedFlag)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "DEBUG ossimInit::initialize(): Already initialized, returning......" << std::endl;
      }
      return;
   }

   theInstance->theAppName  = "";
   theInstance->thePreferences = ossimPreferences::instance();
   theInstance->initializeDefaultFactories();
   
   if ( theElevEnabledFlag )
   {
      theInstance->initializeElevation();
   }

   theInstance->initializeLogFile();

   //---
   // To do:
   // We need a mechanism to register factories to the "front" or the
   // "back" of factory list so that plugins can override things.  For
   // now we will initialize the plugins last...
   //---
   if(thePluginLoaderEnabledFlag)
   {
      theInstance->initializePlugins();
   }

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossim preferences file: "
         << theInstance->thePreferences->getPreferencesFilename()
         << "\nVersion: " << version()
         << "\nossimInit::initialize() leaving..."
         << std::endl;
   } 
   
   theInitializedFlag = true;
#endif
}

initializeDefaultFactories()

void ossimInit::initializeDefaultFactories

(

)

Definition at line 526 of file ossimInit.cpp.

References ossimFactoryListInterface< T, NativeType >::addFactory(), ossimCodecFactoryRegistry::instance(), ossimImageSourceFactoryRegistry::instance(), ossim::ImageHandlerStateFactory::instance(), ossimBaseObjectFactory::instance(), ossimProjectionViewControllerFactory::instance(), ossimImageMetaDataWriterRegistry::instance(), ossimFontFactoryRegistry::instance(), ossimImageGeometryRegistry::instance(), ossimObjectFactoryRegistry::instance(), ossim::ImageHandlerStateRegistry::instance(), ossim2dTo2dTransformRegistry::instance(), ossimProjectionFactoryRegistry::instance(), ossimImageWriterFactoryRegistry::instance(), ossimOverviewBuilderFactory::instance(), ossimDatumFactoryRegistry::instance(), ossimOverviewBuilderFactoryRegistry::instance(), ossimImageHandlerRegistry::instance(), ossim::StreamFactoryRegistry::instance(), and ossimFactoryListInterface< T, NativeType >::registerFactory().

{
   ossim::StreamFactoryRegistry::instance();
   ossim::ImageHandlerStateRegistry::instance()->registerFactory(ossim::ImageHandlerStateFactory::instance());
   ossimObjectFactoryRegistry::instance()->registerFactory(ossimImageSourceFactoryRegistry::instance());

   //---
   // Because of how the imagehandlers work off a magic number make sure
   // we place the writer first if we don't then the imagehandler will
   // be false and will then try to open the filename and go through a
   // magic number and if the file already
   // existed it will open and create a handler instead of a writer.
   //---
   ossimCodecFactoryRegistry::instance();
   ossimImageWriterFactoryRegistry::instance();
   ossimDatumFactoryRegistry::instance();
   ossimImageMetaDataWriterRegistry::instance();
   ossimImageHandlerRegistry::instance();
   ossim2dTo2dTransformRegistry::instance();
   ossimImageGeometryRegistry::instance();
   // Initialize the overview factories.
   ossimOverviewBuilderFactoryRegistry::instance()->
      registerFactory(ossimOverviewBuilderFactory::instance(), true);
   
   ossimObjectFactoryRegistry::instance()->addFactory(ossimBaseObjectFactory::instance());
   
   // initialize. projection factory.
   ossimProjectionFactoryRegistry::instance();

   // add the view controllers
   ossimObjectFactoryRegistry::instance()->registerFactory(ossimProjectionViewControllerFactory::instance());

   ossimFontFactoryRegistry::instance();
}

initializeElevation()

void ossimInit::initializeElevation

(

)

Definition at line 825 of file ossimInit.cpp.

{
   if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::initializeElevation(): Entered..." << std::endl;
   
   const ossimKeywordlist& KWL = thePreferences->preferencesKWL();

#if 0  /* All autoload stuff disabled. drb 20170408 */
   ossimFilename appPath = theAppName.path();
   
   // look for bundled elevation and geoids
   {
      ossimFilename geoid = appPath.dirCat("geoids");
      geoid = geoid.dirCat("geoid1996");
      geoid = geoid.dirCat("egm96.grd");
      if(geoid.exists())
      {
         ossimGeoid* geoidPtr = new ossimGeoidEgm96(geoid);
         
         if (geoidPtr->getErrorStatus() == ossimErrorCodes::OSSIM_OK)
         {
            ossimGeoidManager::instance()->addGeoid(geoidPtr);
         }
         
      }
   }
#endif
   
   ossimGeoidManager::instance()->loadState(KWL);

   //---
   // Auto load removed to avoid un-wanted directory scanning.
   // Use ossim preferences.  drb - 28 March 2016.
   //---
#if 0
   ossimFilename elevation = appPath.dirCat("elevation");
   if(elevation.exists())
   {
      ossimElevManager::instance()->loadElevationPath(elevation);
   }
#endif

   // lets do backward compatability here
   //
   ossimString regExpression =  ossimString("^(") + "elevation_source[0-9]+.)";
   vector<ossimString> keys =
   KWL.getSubstringKeyList( regExpression );
   if(!keys.empty())
   {
      ossimNotify(ossimNotifyLevel_WARN) << "Please specify elevation_source keywords with the new prefix\n"
                                         << "of elevation_manager.elevation_source....\n";
      thePreferences->preferencesKWL().addPrefixToKeysThatMatch("elevation_manager.", regExpression);
   }
   ossimElevManager::instance()->loadState(KWL, "elevation_manager.");
   
   if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::initializeElevation(): leaving..." << std::endl;
}

initializeLogFile()

void ossimInit::initializeLogFile

(

)

Initializes log file from preferences keyword lookup of "ossim.log.file" if log file has not already been set and keyword is set in preferences.

So this should be called after parse options as the –ossim-logfile should override any preferences setting.

Definition at line 884 of file ossimInit.cpp.

References ossimKeywordlist::find(), ossimGetLogFilename(), ossimSetLogFilename(), ossimPreferences::preferencesKWL(), ossimString::size(), and thePreferences.

{
   //---
   // Do not set if already as --ossim-logfile take precidence over preferences
   // file.
   //---
   ossimFilename logFile;
   ossimGetLogFilename(logFile);

   if ( (logFile.size() == 0) && thePreferences )
   {
      const char* lookup =
         thePreferences->preferencesKWL().find("ossim.log.file");
      if (lookup)
      {
         logFile = lookup;
         ossimSetLogFilename(logFile);
      }
   }
}

initializePlugins()

void ossimInit::initializePlugins

(

)

Definition at line 561 of file ossimInit.cpp.

References ossimString::c_str(), ossimFilename::dirCat(), ossimString::empty(), ossimFilename::exists(), ossimKeywordlist::find(), ossimKeywordlist::findKey(), ossimKeywordlist::getNumberOfSubstringKeys(), ossimKeywordlist::getSubstringKeyList(), ossimEnvironmentUtility::getUserOssimPluginDir(), ossimEnvironmentUtility::instance(), ossimSharedPluginRegistry::instance(), ossimPreferences::instance(), loadPlugins(), ossimDirectory::OSSIM_DIR_FILES, ossimFilename::path(), ossimPreferences::preferencesKWL(), ossimSharedPluginRegistry::registerPlugin(), ossimString::size(), ossimString::string(), theAppName, thePreferences, ossimString::toBool(), ossimString::toInt(), and ossimString::toString().

{

#if 0   
   // Note: Removed "autoload" code. Commented out below.
   
   const ossimKeywordlist& KWL = thePreferences->preferencesKWL();

   //---
   // Look for plugins in the form of:
   // plugin0.file: $(OSSIM_INSTALL_PREFIX)/lib64/ossim/plugins/libossim_png_plugin.so
   // plugin0.option: front
   //---
   ossimString regExp =  ossimString("^(") + "plugin[0-9]+.file)";
   ossim_uint32 numberOfPlugins = KWL.getNumberOfSubstringKeys( regExp );
   if ( numberOfPlugins )
   {  
      const ossim_uint32 MAX_INDEX = numberOfPlugins + 1000; // for skipage...
      ossim_uint32 index            = 0;
      ossim_uint32 processedIndexes = 0;
      const std::string PREFIX_BASE = "plugin";
      const std::string DOT         = ".";
      const std::string FILE_KEY    = "file";
      const std::string OPTIONS_KEY = "options";
      
      ossimString prefix;
      ossimFilename pluginFile;
      ossimString pluginOptions;      

      // Loop to load plugins in order. Note allows for skipage.
      while ( processedIndexes < MAX_INDEX )
      {
         prefix = PREFIX_BASE + ossimString::toString(index).string() + DOT; 
         pluginFile = KWL.findKey( prefix, FILE_KEY );
         if ( pluginFile.size() )
         {
            if ( pluginFile.exists() )
            {
               // Found plugin, look for options:
               pluginOptions = KWL.findKey( prefix, OPTIONS_KEY );
               
               ossimSharedPluginRegistry::instance()->registerPlugin(pluginFile, pluginOptions);
            }
            ++processedIndexes;
         }
         if ( processedIndexes == numberOfPlugins )
         {
            break;
         }
         ++index;
      }
   }

   //---
   // Look for plugins in the form of:
   // plugin.file0: $(OSSIM_INSTALL_PREFIX)/lib64/ossim/plugins/libossim_png_plugin.so
   //---
   regExp =  ossimString("^(") + "plugin.file[0-9]+)";
   numberOfPlugins = KWL.getNumberOfSubstringKeys( regExp );
   if ( numberOfPlugins )
   {  
      const ossim_uint32 MAX_INDEX = numberOfPlugins + 1000; // for skipage...
      ossim_uint32 index            = 0;
      ossim_uint32 processedIndexes = 0;
      const std::string PREFIX_BASE = "plugin.file";
      std::string fileKey;
      
      ossimString prefix;
      ossimFilename pluginFile;
      ossimString pluginOptions = ""; // No options:

      // Loop to load plugins in order. Note allows for skipage.
      while ( processedIndexes < MAX_INDEX )
      {
         fileKey = PREFIX_BASE + ossimString::toString(index).string();
         pluginFile = KWL.findKey( fileKey );
         if ( pluginFile.size() )
         {
            if ( pluginFile.exists() )
            {
               ossimSharedPluginRegistry::instance()->registerPlugin(pluginFile, pluginOptions);
            }
            ++processedIndexes;
         }
         
         if ( processedIndexes == numberOfPlugins )
         {
            break;
         }
         ++index;
      }
   }

#else  /* Old code that auto loads plugins. */
   #if 0
   ossimString regExpressionDir =  ossimString("^(") + "plugin.dir[0-9]+)";
   ossimString regExpressionFile =  ossimString("^(") + "plugin.file[0-9]+)";

   const ossimKeywordlist& kwl = thePreferences->preferencesKWL();

   vector<ossimString> keys = kwl.getSubstringKeyList( regExpressionDir );

   ossim_uint32 numberOfDirs = (ossim_uint32)keys.size();
   ossim_uint32 offset = (ossim_uint32)ossimString("plugin.dir").size();
   int idx = 0;
   
   std::vector<int> numberList(numberOfDirs);
   
   // register user plugins first
   ossimFilename userPluginDir = ossimEnvironmentUtility::instance()->getUserOssimPluginDir();
   loadPlugins(userPluginDir);

   if(numberList.size()>0)
   {
      for(idx = 0; idx < (int)numberList.size();++idx)
      {
         ossimString numberStr(keys[idx].begin() + offset,
                               keys[idx].end());
         numberList[idx] = numberStr.toInt();
      }
      
      std::sort(numberList.begin(), numberList.end());
      for(idx=0;idx < (int)numberList.size();++idx)
      {
         ossimString newPrefix = "plugin.dir";
         newPrefix += ossimString::toString(numberList[idx]);
         const char* directory = kwl.find(newPrefix.c_str());
         
         if(directory)
         {
            loadPlugins(ossimFilename(directory));
         }
      }
   }
   keys = kwl.getSubstringKeyList( regExpressionFile );
   
   ossim_uint32 numberOfFiles = (ossim_uint32)keys.size();
   offset = (ossim_uint32)ossimString("plugin.file").size();
   numberList.resize(numberOfFiles);
   if(numberList.size()>0)
   {
      for(idx = 0; idx < (int)numberList.size();++idx)
      {
         ossimString numberStr(keys[idx].begin() + offset,
                               keys[idx].end());
         numberList[idx] = numberStr.toInt();
      }
      
      std::sort(numberList.begin(), numberList.end());   
      for(idx=0;idx < (int)numberList.size();++idx)
      {
         ossimString newPrefix="plugin.file";
         newPrefix += ossimString::toString(numberList[idx]);
         const char* file = kwl.find(newPrefix.c_str());
         
         if(file&&ossimFilename(file).exists())
         {
            loadPlugins(file);
//             ossimSharedPluginRegistry::instance()->registerPlugin(file);
         }
      }
   }
   #endif   
   // now check new plugin loading that supports passing options to the plugins
   // 
   const ossimKeywordlist& kwl = thePreferences->preferencesKWL();
   ossimString regExpressionFile =  ossimString("^(") + "plugin[0-9]+\\.file)";
   vector<ossimString> keys = kwl.getSubstringKeyList( regExpressionFile );
   
   ossim_uint32 numberOfFiles = (ossim_uint32)keys.size();
   ossim_uint32 offset = (ossim_uint32)ossimString("plugin").size();
   std::vector<int> numberList(numberOfFiles);
   
   if(numberList.size()>0)
   {
      ossim_uint32 idx = 0;
      for(idx = 0; idx < numberList.size();++idx)
      {
         ossimString numberStr(keys[idx].begin() + offset,
                               keys[idx].end());
         numberList[idx] = numberStr.toInt();
      }
      std::sort(numberList.begin(), numberList.end());
      ossimFilename pluginFile;
      ossimString options;
      for(std::vector<ossim_int32>::const_iterator iter = numberList.begin();
         iter != numberList.end();++iter)
      {
         ossimString newPrefix = ossimString("plugin")+ossimString::toString(*iter) + ".";
       
         pluginFile = kwl.find((newPrefix+"file").c_str());
         options    = kwl.find((newPrefix+"options").c_str());
         if(pluginFile.exists())
         {
            ossimSharedPluginRegistry::instance()->registerPlugin(pluginFile, options);
         }
      }
   }

   regExpressionFile =  ossimString("^(") + "plugin.file[0-9]+)";
   keys = kwl.getSubstringKeyList( regExpressionFile );
   
   numberOfFiles = (ossim_uint32)keys.size();
   offset = (ossim_uint32)ossimString("plugin.file").size();
   numberList.resize(numberOfFiles);
   
   if(numberList.size()>0)
   {
      ossim_uint32 idx = 0;
      for(idx = 0; idx < numberList.size();++idx)
      {
         ossimString numberStr(keys[idx].begin() + offset,
                               keys[idx].end());
         numberList[idx] = numberStr.toInt();
      }
      std::sort(numberList.begin(), numberList.end());
      ossimFilename pluginFile;
      ossimString options;
      for(std::vector<ossim_int32>::const_iterator iter = numberList.begin();
         iter != numberList.end();++iter)
      {
         ossimString newPrefix = ossimString("plugin.file")+ossimString::toString(*iter);
       
         pluginFile = kwl.find(newPrefix.c_str());
         if(pluginFile.exists())
         {
            ossimSharedPluginRegistry::instance()->registerPlugin(pluginFile, options);
         }
      }
   }



   ossimString auto_load_plugins(ossimPreferences::instance()->findPreference("ossim_init.auto_load_plugins"));
   
   if(auto_load_plugins.empty()) auto_load_plugins = "false";
   // now load any plugins not found in the keywordlist
   //
   // check for plugins in the current directory
   // and load them
   if(auto_load_plugins.toBool())
   {
      ossimFilename ossimpluginsDir = ossimFilename(theAppName).dirCat("ossimplugins");
      ossimDirectory currentDir(theAppName.path());

      if(ossimpluginsDir.exists())
      {
         currentDir = ossimpluginsDir;
      }
      std::vector<ossimFilename> result;
      currentDir.findAllFilesThatMatch(result, "ossim.*plugin.*", ossimDirectory::OSSIM_DIR_FILES);
      
      if(result.size())
      {
         ossim_uint32 idx = 0;
         for(idx = 0; idx < result.size(); ++idx)
         {
            ossimSharedPluginRegistry::instance()->registerPlugin(result[idx]);
         }
      }
   }
#endif
}

instance()

ossimInit * ossimInit::instance ( )

static

Returns the static instance of an ossimInit object. This is of no use until non-static methods are implemented.

Definition at line 89 of file ossimInit.cpp.

References ossimInit(), and theInstance.

Referenced by main(), ossimHillshadeTool::setUsage(), ossimInfo::setUsage(), ossimChipProcTool::setUsage(), ossimTool::setUsage(), ossimPointCloudTool::usage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), and ossimChipperUtil::usage().

{
   static std::mutex m;
   std::lock_guard<std::mutex> lock(m);
   if (!theInstance)
   {
      theInstance = new ossimInit();
   }
   return theInstance;
}

loadPlugins()

void ossimInit::loadPlugins	(	const ossimFilename &	plugin,
		const char *	options = 0
	)

Can take a file or a directory.

If a directory is givien then it will check all files in the directory and add each file that is detected to be a valid plugin.

Parameters

plugin	Is the filename of the plugin to load
options	Is a keywordlist of plugin specific options

Definition at line 305 of file ossimInit.cpp.

References ossimFilename::exists(), ossimDirectory::getFirst(), ossimDirectory::getNext(), ossimSharedPluginRegistry::instance(), ossimFilename::isDir(), ossimDirectory::open(), ossimDirectory::OSSIM_DIR_FILES, ossimSharedPluginRegistry::registerPlugin(), and thePluginLoaderEnabledFlag.

Referenced by initializePlugins().

{
   if(!thePluginLoaderEnabledFlag) return;

   if(plugin.exists())
   {
      if(plugin.isDir())
      {
         ossimDirectory dir;
         if(dir.open(plugin))
         {
            ossimFilename file;
            
            if(dir.getFirst(file, ossimDirectory::OSSIM_DIR_FILES))
            {
               do
               { 
                  ossimSharedPluginRegistry::instance()->registerPlugin(file, options);
               }
               while(dir.getNext(file));
            }
         }
      }
      else
      {
         ossimSharedPluginRegistry::instance()->registerPlugin(plugin, options);
      }
   }
}

operator=()

void ossimInit::operator= ( const ossimInit &  rhs ) const

protected

Hidden from use assignment operator.

Definition at line 938 of file ossimInit.cpp.

{}

parseEnvOptions()

void ossimInit::parseEnvOptions ( ossimArgumentParser &  parser )

protected

Definition at line 474 of file ossimInit.cpp.

References ossimString::after(), ossimString::before(), ossimString::c_str(), ossimString::contains(), ossimEnvironmentUtility::instance(), ossimArgumentParser::read(), and ossimEnvironmentUtility::setEnvironmentVariable().

{
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParameter(tempString);
   while(parser.read("--env", stringParameter))
   {
      ossimString option = tempString;
      if (option.contains("=") )
      {
         ossimString delimiter = "=";
         ossimString key (option.before(delimiter));
         ossimString value = option.after(delimiter);
         ossimEnvironmentUtility::instance()->setEnvironmentVariable(key.c_str(), value.c_str());

      }
      else
      {
         ossimString key (option);
         ossimEnvironmentUtility::instance()->setEnvironmentVariable(key.c_str(), "");
      }
   }
}

parseNotifyOption()

void ossimInit::parseNotifyOption ( ossimArgumentParser &  parser )

protected

Definition at line 438 of file ossimInit.cpp.

References ossimString::downcase(), ossimDisableNotify(), ossimNotifyFlags_ALL, ossimNotifyFlags_DEBUG, ossimNotifyFlags_FATAL, ossimNotifyFlags_INFO, ossimNotifyFlags_NOTICE, ossimNotifyFlags_WARN, and ossimArgumentParser::read().

{
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParameter(tempString);
   while(parser.read("--disable-notify", stringParameter))
   {
      ossimString tempDownCase = tempString;
      tempDownCase = tempDownCase.downcase();

      if(tempDownCase == "warn")
      {
         ossimDisableNotify(ossimNotifyFlags_WARN);
      }
      else if(tempDownCase == "fatal")
      {
         ossimDisableNotify(ossimNotifyFlags_FATAL);
      }
      else if(tempDownCase == "debug")
      {
         ossimDisableNotify(ossimNotifyFlags_DEBUG);
      }
      else if(tempDownCase == "info")
      {
         ossimDisableNotify(ossimNotifyFlags_INFO);
      }
      else if(tempDownCase == "notice")
      {
         ossimDisableNotify(ossimNotifyFlags_NOTICE);
      }
      else if(tempDownCase == "all")
      {
         ossimDisableNotify(ossimNotifyFlags_ALL);
      }
   }
}

parseOptions()

void ossimInit::parseOptions ( ossimArgumentParser &  parser )

protected

Definition at line 379 of file ossimInit.cpp.

{
   if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::parseOptions: entering..." << std::endl;
   
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParameter(tempString);

   tempString = "";

   while(parser.read("-T", stringParameter))
   {
      ossimTraceManager::instance()->setTracePattern(ossimString(tempString));
   }

   while(parser.read("--ossim-logfile", stringParameter))
   {
      ossimSetLogFilename(ossimFilename(tempString));
   }
   while(parser.read("--disable-notify", stringParameter))
   {
      ossimString tempDownCase = tempString;
      tempDownCase = tempDownCase.downcase();

      if(tempDownCase == "warn")
      {
         ossimDisableNotify(ossimNotifyFlags_WARN);
      }
      else if(tempDownCase == "fatal")
      {
         ossimDisableNotify(ossimNotifyFlags_FATAL);
      }
      else if(tempDownCase == "debug")
      {
         ossimDisableNotify(ossimNotifyFlags_DEBUG);
      }
      else if(tempDownCase == "info")
      {
         ossimDisableNotify(ossimNotifyFlags_INFO);
      }
      else if(tempDownCase == "notice")
      {
         ossimDisableNotify(ossimNotifyFlags_NOTICE);
      }
      else if(tempDownCase == "all")
      {
         ossimDisableNotify(ossimNotifyFlags_ALL);
      }
   }
   if(parser.read("--disable-elev"))
   {
      theElevEnabledFlag = false;
   }
   if(parser.read("--disable-plugin"))
   {
      thePluginLoaderEnabledFlag = false;
   }
}

parsePrefsOptions()

void ossimInit::parsePrefsOptions ( ossimArgumentParser &  parser )

protected

Definition at line 335 of file ossimInit.cpp.

{
   if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::parseOptions: entering..." << std::endl;

   
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParameter(tempString);

   tempString = "";
   ossimString prefsFile = ossimEnvironmentUtility::instance()->getEnvironmentVariable("OSSIM_PREFS_FILE");
   theInstance->thePreferences = ossimPreferences::instance();
   if(!prefsFile.empty())
   {
      thePreferences->loadPreferences();// Use the default load 
   }
   tempString = "";
   // override ENV with passed in variable
   while(parser.read("-P", stringParameter));

   if(tempString != "")
   {
      thePreferences->loadPreferences(ossimFilename(tempString));
   }
   tempString = "";
   while(parser.read("-K", stringParameter))
   {
      ossimString option = tempString;
      if (option.contains("=") )
      {
         ossimString delimiter = "=";
         ossimString key (option.before(delimiter));
         ossimString value = option.after(delimiter);
         thePreferences->addPreference(key.c_str(), value.c_str());
      }
      else
      {
         ossimString key (option);
         thePreferences->addPreference(key, "");
      }
   }

}

removeOption()

void ossimInit::removeOption ( int &  argc, char **  argv, int  argToRemove  )

protected

METHOD: removeOptions() Utility for stripping from argv all characters associated with a particular option:

---

METHOD: ossimInit::removeOption()

Removes all characters associated with the indicated option from the command line string.

Definition at line 503 of file ossimInit.cpp.

{
   if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::removeOption(argc, argv, argToRemove): entering..."
      << std::endl;
   
   // Shift the args up by one position, overwriting the arg being removed:
   for (int i=argToRemove+1; i<argc;  i++)
   {
      argv[i - 1] = argv[i];
   }
   
   argc--;
   argv[argc] = 0;
   
   if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG)
      << "DEBUG ossimInit::removeOption(argc, argv, argToRemove): leaving..."
      << std::endl;
   return;
}

setElevEnabledFlag()

void ossimInit::setElevEnabledFlag

(

bool

flag

)

Sets theElevEnabledFlag.

Parameters

flag	If true ossimElevManager will be initialized. Set to false to NOT initialize the ossimElevManager from preferences. Default in class is true.

Definition at line 295 of file ossimInit.cpp.

References theElevEnabledFlag.

{
   theElevEnabledFlag = flag; 
}

setPluginLoaderEnabledFlag()

void ossimInit::setPluginLoaderEnabledFlag

(

bool

flag

)

Definition at line 300 of file ossimInit.cpp.

References thePluginLoaderEnabledFlag.

{
   thePluginLoaderEnabledFlag = flag;  
}

usage()

void ossimInit::usage

(

)

METHOD: usage() Prints to stdout the list of command line options that this object parses

---

Prints to stdout the list of command line options that this object parses.

Definition at line 268 of file ossimInit.cpp.

References ossimNotify(), and ossimNotifyLevel_INFO.

{
   ossimNotify(ossimNotifyLevel_INFO)
      << "INFORMATION ossimInit::usage():\n"
      << "Additional command-line options available are as follows: "
      << "\n"
      << "\n  -P<pref_filename> -- Allows the user to override the loading "
      << "\n    of the default preferences with their own pref file."
      << "\n"
      << "\n  -K<keyword>[=<value>] -- Allows the user to specify additional"
      << "\n    keyword/value pairs that are added onto the preferences "
      << "\n    previously loaded. Keywords specified here override those in"
      << "\n    the preferences file."
      << "\n"
      << "\n  -T<trace_tag> -- Lets user turn on specific trace flags."
      << "\n"
      << "\n  -S<session_filename> -- Allows user to specify a session file"
      << "\n    to load."
      << std::endl;
   return;
}

version()

ossimString ossimInit::version

(

)

const

Returns

The version in the form of: "version major.minor.release (yyyymmdd)" where yyyymmdd is the build date.

e.g. "version 1.7.0 (20071003)"

Definition at line 905 of file ossimInit.cpp.

References OSSIM_BUILD_DATE, and OSSIM_VERSION.

{
   ossimString versionString;
#ifdef OSSIM_VERSION
   versionString += OSSIM_VERSION;
#else
   versionString += "Version ?.?.?";
#endif
   
   versionString += " ";

#ifdef OSSIM_BUILD_DATE
   versionString += OSSIM_BUILD_DATE;
#else
   versionString += "(yyyymmdd)";
#endif

   return versionString;
}

Member Data Documentation

theAppName

ossimFilename ossimInit::theAppName

protected

Definition at line 148 of file ossimInit.h.

Referenced by appName(), and initializePlugins().

theElevEnabledFlag

bool ossimInit::theElevEnabledFlag

protected

Definition at line 150 of file ossimInit.h.

Referenced by getElevEnabledFlag(), and setElevEnabledFlag().

theInitializedFlag

bool ossimInit::theInitializedFlag

protected

Definition at line 147 of file ossimInit.h.

Referenced by initialize().

theInstance

ossimInit * ossimInit::theInstance = 0

staticprotected

Definition at line 146 of file ossimInit.h.

Referenced by initialize(), instance(), and ~ossimInit().

thePluginLoaderEnabledFlag

bool ossimInit::thePluginLoaderEnabledFlag

protected

Definition at line 151 of file ossimInit.h.

Referenced by loadPlugins(), and setPluginLoaderEnabledFlag().

thePreferences

ossimPreferences* ossimInit::thePreferences

protected

Definition at line 149 of file ossimInit.h.

Referenced by initializeLogFile(), and initializePlugins().

---

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

• ossimInit.h
• ossimInit.cpp