---

edmplugin::PluginFactoryBase Class Reference

#include <FWCore/PluginManager/interface/PluginFactoryBase.h>

Inheritance diagram for edmplugin::PluginFactoryBase:

List of all members.

Public Member Functions
virtual std::vector< PluginInfo >	available () const =0
	return info about all plugins which are already available in the program
virtual const std::string &	category () const =0
	returns the name of the category to which this plugin factory belongs
	PluginFactoryBase ()
virtual	~PluginFactoryBase ()
Public Attributes
sigc::signal< void, const std::string &, const PluginInfo & >	newPluginAdded_
	signal containing plugin category, and plugin info for newly added plugin
Protected Member Functions
template<typename Plugins>
Plugins::const_iterator	findPMaker (const std::string &iName, const Plugins &iPlugins) const
void	finishedConstruction ()
	call this as the last line in the constructor of inheriting classes this is done so that the virtual table will be properly initialized when the routine is called
void	newPlugin (const std::string &iName)
template<typename Plugins>
Plugins::const_iterator	tryToFindPMaker (const std::string &iName, const Plugins &iPlugins) const
Static Protected Member Functions
template<typename PluginsItr>
static void	fillAvailable (PluginsItr iBegin, PluginsItr iEnd, std::vector< PluginInfo > &iReturn)
template<typename MakersItr>
static void	fillInfo (MakersItr iBegin, MakersItr iEnd, PluginInfo &iInfo, std::vector< PluginInfo > &iReturn)
Private Member Functions
void	checkProperLoadable (const std::string &iName, const std::string &iLoadedFrom) const
const PluginFactoryBase &	operator= (const PluginFactoryBase &)
	PluginFactoryBase (const PluginFactoryBase &)

---

Detailed Description

Definition at line 34 of file PluginFactoryBase.h.

---

Constructor & Destructor Documentation

edmplugin::PluginFactoryBase::PluginFactoryBase

(

)

[inline]

Definition at line 38 of file PluginFactoryBase.h.

{}

PluginFactoryBase::~PluginFactoryBase

(

)

[virtual]

Definition at line 38 of file PluginFactoryBase.cc.

{
}

edmplugin::PluginFactoryBase::PluginFactoryBase

(

const PluginFactoryBase &

)

[private]

---

Member Function Documentation

virtual std::vector<PluginInfo> edmplugin::PluginFactoryBase::available

(

)

const [pure virtual]

return info about all plugins which are already available in the program

Implemented in edmplugin::PluginCapabilities, edmplugin::PluginFactory< R *(void)>, edmplugin::PluginFactory< R *(Arg)>, and edmplugin::PluginFactory< R *(Arg1, Arg2)>.

virtual const std::string& edmplugin::PluginFactoryBase::category

(

)

const [pure virtual]

returns the name of the category to which this plugin factory belongs

Implemented in edmplugin::PluginCapabilities, edmplugin::PluginFactory< R *(void)>, edmplugin::PluginFactory< R *(Arg)>, and edmplugin::PluginFactory< R *(Arg1, Arg2)>.

Referenced by checkProperLoadable().

void edmplugin::PluginFactoryBase::checkProperLoadable	(	const std::string &	iName,
		const std::string &	iLoadedFrom
	)			const [inline, private]

Definition at line 141 of file PluginFactoryBase.h.

References category(), Exception, edmplugin::PluginManager::get(), DBSPlugin::get(), edmplugin::PluginManager::isAvailable(), and edmplugin::PluginManager::staticallyLinkedLoadingFileName().

Referenced by findPMaker(), and tryToFindPMaker().

                                                                                           {
        //should check to see if this is from the proper loadable if it
        // was not statically linked
        if (iLoadedFrom != PluginManager::staticallyLinkedLoadingFileName() &&
            PluginManager::isAvailable()) {
          if( iLoadedFrom != PluginManager::get()->loadableFor(category(),iName).native_file_string() ) {
            throw cms::Exception("WrongPluginLoaded")<<"The plugin '"<<iName<<"' should have been loaded from\n '"
            <<PluginManager::get()->loadableFor(category(),iName).native_file_string()
            <<"'\n but instead it was already loaded from\n '"
            <<iLoadedFrom<<"'\n because some other plugin was loaded from the latter loadables.\n"
            "To work around the problem the plugin '"<<iName<<"' should only be defined in one of these loadables.";
          }
        }
      }

template<typename PluginsItr>

static void edmplugin::PluginFactoryBase::fillAvailable	(	PluginsItr	iBegin,
		PluginsItr	iEnd,
		std::vector< PluginInfo > &	iReturn
	)			[inline, static, protected]

Definition at line 122 of file PluginFactoryBase.h.

References fillInfo(), info, it, and edmplugin::PluginInfo::name_.

                                                                {
        PluginInfo info;
        for( PluginsItr it = iBegin;
            it != iEnd;
            ++it) {
          info.name_ = it->first;
          fillInfo(it->second.begin(),it->second.end(),
                   info, iReturn);
        }
      }

template<typename MakersItr>

static void edmplugin::PluginFactoryBase::fillInfo	(	MakersItr	iBegin,
		MakersItr	iEnd,
		PluginInfo &	iInfo,
		std::vector< PluginInfo > &	iReturn
	)			[inline, static, protected]

Definition at line 111 of file PluginFactoryBase.h.

References it, and edmplugin::PluginInfo::loadable_.

Referenced by fillAvailable().

                                                              {
          for(MakersItr it = iBegin;
              it != iEnd;
              ++it) {
            iInfo.loadable_ = it->second;
            iReturn.push_back(iInfo);
          }
        }

template<typename Plugins>

Plugins::const_iterator edmplugin::PluginFactoryBase::findPMaker	(	const std::string &	iName,
		const Plugins &	iPlugins
	)			const [inline, protected]

Definition at line 69 of file PluginFactoryBase.h.

References checkProperLoadable(), Exception, DBSPlugin::get(), and path().

Referenced by edmplugin::PluginFactory< R *(Arg1, Arg2)>::create(), edmplugin::PluginFactory< R *(Arg)>::create(), and edmplugin::PluginFactory< R *(void)>::create().

                                                                                  {
        //do we already have it?
        typename Plugins::const_iterator itFound = iPlugins.find(iName);
        if(itFound == iPlugins.end()) {
          std::string lib = PluginManager::get()->load(this->category(),iName).path().native_file_string();
          itFound = iPlugins.find(iName);
          if(itFound == iPlugins.end()) {
            throw cms::Exception("PluginCacheError")<<"The plugin '"<<iName<<"' should have been in loadable\n '"
            <<lib<<"'\n but was not there.  This means the plugin cache is incorrect.  Please run 'EdmPluginRefresh "<<lib<<"'";
          }
        } else {
          checkProperLoadable(iName,itFound->second.front().second);
        }
        return itFound;
      }

void PluginFactoryBase::finishedConstruction

(

)

[protected]

call this as the last line in the constructor of inheriting classes this is done so that the virtual table will be properly initialized when the routine is called

Definition at line 58 of file PluginFactoryBase.cc.

References DBSPlugin::get().

{
   PluginFactoryManager::get()->addFactory(this);
}

void PluginFactoryBase::newPlugin

(

const std::string &

iName

)

[protected]

Definition at line 64 of file PluginFactoryBase.cc.

References category, info, edmplugin::PluginInfo::loadable_, edmplugin::PluginInfo::name_, and path().

{
  PluginInfo info;
  info.loadable_=boost::filesystem::path(PluginManager::loadingFile(),boost::filesystem::no_check);
  info.name_=iName;
  newPluginAdded_(category(),info);
}

const PluginFactoryBase& edmplugin::PluginFactoryBase::operator=

(

const PluginFactoryBase &

)

[private]

template<typename Plugins>

Plugins::const_iterator edmplugin::PluginFactoryBase::tryToFindPMaker	(	const std::string &	iName,
		const Plugins &	iPlugins
	)			const [inline, protected]

Definition at line 88 of file PluginFactoryBase.h.

References checkProperLoadable(), Exception, DBSPlugin::get(), and edmplugin::SharedLibrary::path().

Referenced by edmplugin::PluginFactory< R *(Arg)>::tryToCreate(), edmplugin::PluginFactory< R *(Arg1, Arg2)>::tryToCreate(), and edmplugin::PluginFactory< R *(void)>::tryToCreate().

      {
        //do we already have it?
        typename Plugins::const_iterator itFound = iPlugins.find(iName);
        if(itFound == iPlugins.end()) {
          const SharedLibrary* slib = PluginManager::get()->tryToLoad(this->category(),iName);
          if(0!=slib) {
            std::string lib = slib->path().native_file_string();
            itFound = iPlugins.find(iName);
            if(itFound == iPlugins.end()) {
              throw cms::Exception("PluginCacheError")<<"The plugin '"<<iName<<"' should have been in loadable\n '"
              <<lib<<"'\n but was not there.  This means the plugin cache is incorrect.  Please run 'EdmPluginRefresh "<<lib<<"'";
            }
          }
        } else {
          checkProperLoadable(iName,itFound->second.front().second);
        }
        return itFound;
      }

---

Member Data Documentation

sigc::signal<void,const std::string&, const PluginInfo&> edmplugin::PluginFactoryBase::newPluginAdded_ [mutable]

signal containing plugin category, and plugin info for newly added plugin

Definition at line 50 of file PluginFactoryBase.h.

---

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

• FWCore/PluginManager/interface/PluginFactoryBase.h
• FWCore/PluginManager/src/PluginFactoryBase.cc

---