ossimSharedPluginRegistry Class Reference

#include <ossimSharedPluginRegistry.h>

Public Member Functions
virtual	~ossimSharedPluginRegistry ()
bool	registerPlugin (const ossimFilename &filename, const ossimString &options="")
bool	unregisterPlugin (int idx)
bool	unregisterPlugin (ossimPluginLibrary *plugin)
const ossimPluginLibrary *	getPlugin (const ossimFilename &filename) const
ossimPluginLibrary *	getPlugin (const ossimFilename &filename)
ossim_uint32	getIndex (const ossimPluginLibrary *lib) const
ossimPluginLibrary *	getPlugin (ossim_uint32 idx)
const ossimPluginLibrary *	getPlugin (ossim_uint32 idx) const
ossim_uint32	getNumberOfPlugins () const
bool	isLoaded (const ossimFilename &filename) const
	Checks if filename is already loaded to avoid duplication. More...
void	printAllPluginInformation (std::ostream &out)

Static Public Member Functions
static ossimSharedPluginRegistry *	instance ()

Protected Member Functions
	ossimSharedPluginRegistry ()
	ossimSharedPluginRegistry (const ossimSharedPluginRegistry &)
void	operator= (const ossimSharedPluginRegistry &)

Protected Attributes
std::vector< ossimRefPtr< ossimPluginLibrary > >	theLibraryList

Detailed Description

Definition at line 10 of file ossimSharedPluginRegistry.h.

Constructor & Destructor Documentation

~ossimSharedPluginRegistry()

ossimSharedPluginRegistry::~ossimSharedPluginRegistry ( )

virtual

Definition at line 28 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

{
   theLibraryList.clear();
}

ossimSharedPluginRegistry() [1/2]

ossimSharedPluginRegistry::ossimSharedPluginRegistry ( )

protected

Definition at line 24 of file ossimSharedPluginRegistry.cpp.

{
}

ossimSharedPluginRegistry() [2/2]

ossimSharedPluginRegistry::ossimSharedPluginRegistry ( const ossimSharedPluginRegistry &  )

inlineprotected

Definition at line 41 of file ossimSharedPluginRegistry.h.

{}

Member Function Documentation

getIndex()

ossim_uint32 ossimSharedPluginRegistry::getIndex

(

const ossimPluginLibrary *

lib

)

const

Definition at line 141 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

{
   ossim_uint32 idx = 0;

   for(idx = 0; idx < theLibraryList.size(); ++idx)
   {
      if(theLibraryList[idx] == lib)
      {
         return idx;
      }
   }

   return idx;
}

getNumberOfPlugins()

ossim_uint32 ossimSharedPluginRegistry::getNumberOfPlugins

(

)

const

Definition at line 180 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

Referenced by isLoaded(), and printAllPluginInformation().

{
   return (ossim_uint32)theLibraryList.size();
}

getPlugin() [1/4]

const ossimPluginLibrary * ossimSharedPluginRegistry::getPlugin

(

const ossimFilename &

filename

)

const

Definition at line 110 of file ossimSharedPluginRegistry.cpp.

References ossimFilename::file(), and theLibraryList.

Referenced by isLoaded(), printAllPluginInformation(), registerPlugin(), and unregisterPlugin().

{
   ossim_uint32 idx = 0;
   ossimFilename fileOnly = filename.file();
   for(idx = 0; idx < theLibraryList.size();++idx)
   {
      if(fileOnly == ossimFilename(theLibraryList[idx]->getName()).file())
      {
         return theLibraryList[idx].get();
      }
   }
   
   return 0;
}

getPlugin() [2/4]

ossimPluginLibrary * ossimSharedPluginRegistry::getPlugin

(

const ossimFilename &

filename

)

Definition at line 125 of file ossimSharedPluginRegistry.cpp.

References ossimFilename::file(), and theLibraryList.

{
   ossim_uint32 idx = 0;
   ossimFilename fileOnly = filename.file();

   for(idx = 0; idx < theLibraryList.size();++idx)
   {
      if(fileOnly == ossimFilename(theLibraryList[idx]->getName()).file())
      {
         return theLibraryList[idx].get();
      }
   }
   
   return 0;
}

getPlugin() [3/4]

ossimPluginLibrary * ossimSharedPluginRegistry::getPlugin

(

ossim_uint32

idx

)

Definition at line 156 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

{
   ossimPluginLibrary* result = 0;
   
   if(idx < theLibraryList.size())
   {
      result = theLibraryList[idx].get();
   }

   return result;
}

getPlugin() [4/4]

const ossimPluginLibrary * ossimSharedPluginRegistry::getPlugin

(

ossim_uint32

idx

)

const

Definition at line 168 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

{
   const ossimPluginLibrary* result = 0;
   
   if(idx < theLibraryList.size())
   {
      result = theLibraryList[idx].get();
   }

   return result;
}

instance()

ossimSharedPluginRegistry * ossimSharedPluginRegistry::instance ( )

static

Definition at line 33 of file ossimSharedPluginRegistry.cpp.

Referenced by ossimInit::initializePlugins(), ossimInit::loadPlugins(), ossimInfo::printPlugins(), and ossimInfo::testPlugin().

{
   static ossimSharedPluginRegistry sharedInstance;

   return &sharedInstance;//theInstance;
}

isLoaded()

bool ossimSharedPluginRegistry::isLoaded

(

const ossimFilename &

filename

)

const

Checks if filename is already loaded to avoid duplication.

Parameters

filename

The file to check.

Returns

true if any of the plugins match file name, false if not.

Definition at line 186 of file ossimSharedPluginRegistry.cpp.

References ossimFilename::file(), ossimDynamicLibrary::getName(), getNumberOfPlugins(), and getPlugin().

{
   ossimFilename fileOnly = filename.file();
   bool result = false;
   ossim_uint32 count = getNumberOfPlugins();
   for (ossim_uint32 i = 0; i < count; ++i)
   {
      const ossimPluginLibrary* pi = getPlugin(i);
      if (pi)
      {
         if (fileOnly == ossimFilename(pi->getName()).file())
         {
            result = true;
            break;
         }
      }
   }
   return result;
}

operator=()

void ossimSharedPluginRegistry::operator= ( const ossimSharedPluginRegistry &  )

inlineprotected

Definition at line 42 of file ossimSharedPluginRegistry.h.

{}

printAllPluginInformation()

void ossimSharedPluginRegistry::printAllPluginInformation

(

std::ostream &

out

)

Definition at line 207 of file ossimSharedPluginRegistry.cpp.

References ossimPluginLibrary::getClassNames(), ossimPluginLibrary::getDescription(), ossimDynamicLibrary::getName(), getNumberOfPlugins(), and getPlugin().

Referenced by ossimInfo::printPlugins().

{
   ossim_uint32 count = getNumberOfPlugins();
   ossim_uint32 idx = 0;
   
   for(idx = 0; idx < count; ++idx)
   {
      std::vector<ossimString> classNames;
      const ossimPluginLibrary* pi = getPlugin(idx);
      if(pi)
      {
         pi->getClassNames(classNames);
         out << "Plugin: " << pi->getName() << std::endl;
         out << "DESCRIPTION: \n";
         out << pi->getDescription() << "\n";
         out << "CLASSES SUPPORTED\n     ";
         std::copy(classNames.begin(),
                   classNames.end(),
                   std::ostream_iterator<ossimString>(out, "\n     "));
         out << "\n";
      }
   }
}

registerPlugin()

bool ossimSharedPluginRegistry::registerPlugin	(	const ossimFilename &	filename,
		const ossimString &	options = ""
	)

Definition at line 40 of file ossimSharedPluginRegistry.cpp.

References getPlugin(), ossimDynamicLibrary::getSymbol(), ossimPluginLibrary::initialize(), ossimDynamicLibrary::load(), ossimPluginLibrary::setOptions(), and theLibraryList.

Referenced by ossimInit::initializePlugins(), and ossimInit::loadPlugins().

{
   bool result = false;
   if(!getPlugin(filename))
   {
      ossimPluginLibrary *lib =new ossimPluginLibrary;
      if(lib->load(filename))
      {
         lib->setOptions(options);
         if(lib->getSymbol("ossimSharedLibraryInitialize"))
         {
            lib->initialize();
//            if(!insertFrontFlag)
//            {
            theLibraryList.push_back(lib);
//            }
//            else
//            {
//               theLibraryList.insert(theLibraryList.begin(), lib);
            //           }
            result = true;
         }
         else if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimSharedPluginRegistry DEBUG:"
               << "ossimSharedLibraryInitialize symbol not found\n"
               << std::endl;
         }
      }
      
      if ( !result )
      {
         delete lib;
         lib = 0;
      }
      
   }
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "WARNING: Plugin with the name " << filename << std::endl
         << "Already registered with OSSIM" << std::endl;
   }
   
   return result;
}

unregisterPlugin() [1/2]

bool ossimSharedPluginRegistry::unregisterPlugin

(

int

idx

)

Definition at line 88 of file ossimSharedPluginRegistry.cpp.

References getPlugin().

{
   ossimPluginLibrary* lib = getPlugin(idx);
   
   return unregisterPlugin(lib);
}

unregisterPlugin() [2/2]

bool ossimSharedPluginRegistry::unregisterPlugin

(

ossimPluginLibrary *

plugin

)

Definition at line 95 of file ossimSharedPluginRegistry.cpp.

References theLibraryList.

{
   std::vector<ossimRefPtr<ossimPluginLibrary> >::iterator iter = theLibraryList.begin();
   while(iter!=theLibraryList.end())
   {
      if((*iter).get() == library)
      {
         theLibraryList.erase(iter);
         return true;
      }
      ++iter;
   }
   return false;
}

Member Data Documentation

theLibraryList

std::vector<ossimRefPtr<ossimPluginLibrary> > ossimSharedPluginRegistry::theLibraryList

protected

Definition at line 45 of file ossimSharedPluginRegistry.h.

Referenced by getIndex(), getNumberOfPlugins(), getPlugin(), registerPlugin(), unregisterPlugin(), and ~ossimSharedPluginRegistry().

---

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

• ossimSharedPluginRegistry.h
• ossimSharedPluginRegistry.cpp