ossimInit.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  See top level LICENSE.txt file.
// 
// DESCRIPTION:
//   Contains declaration of class ossimInit. This object handles all aspects
//   of initialization for OSSIM applications. These tasks include:
//
//      1. Parsing the command line.
//      2. Instantiating all class factories as declared in ossimFactories.h
//      3. Initializing the "trace" code execution tracing functionality.
//      4. Scanning the preferences file for relevant values.
//
// SOFTWARE HISTORY:
//>
//   24Apr2001  Oscar Kramer
//              Initial coding.
//<
//*****************************************************************************
// $Id: ossimInit.h 19440 2011-04-25 16:41:28Z dburken $
#ifndef ossimInit_HEADER
#define ossimInit_HEADER 1

#include <ossim/base/ossimFilename.h>

class ossimPreferences;
class ossimArgumentParser;

class OSSIMDLLEXPORT ossimInit
{
public:

   ~ossimInit();
   static ossimInit* instance();

   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);

   void setPluginLoaderEnabledFlag(bool flag);

   void loadPlugins(const ossimFilename& plugin, const char* options=0);
   
   void initializePlugins();
   void initializeDefaultFactories();
   void initializeElevation();

   void initializeLogFile();

   ossimString version() const;

   ossimFilename appName()const;

protected:
   ossimInit();

   ossimInit(const ossimInit& obj);
   
   void operator=(const ossimInit& rhs) const;
   
   void parseOptions(ossimArgumentParser& parser);

   void parseNotifyOption(ossimArgumentParser& parser);
   void parseEnvOptions(ossimArgumentParser& parser);
   void parsePrefsOptions(ossimArgumentParser& parser);
   void removeOption(int&   argc, 
                     char** argv,
                     int    argToRemove);
   
   static ossimInit*  theInstance;
   bool               theInitializedFlag;  
   ossimFilename      theAppName;
   ossimPreferences*  thePreferences;
   bool               theElevEnabledFlag;
   bool               thePluginLoaderEnabledFlag;
};

#endif