AnalysisLoader Class Reference

#include <AnalysisLoader.hh>

Collaboration diagram for AnalysisLoader:

[legend]

List of all members.

---

Detailed Description

Definition at line 17 of file AnalysisLoader.hh.

Static Public Member Functions
static vector< string >	analysisNames ()
	Get all the available analyses' names.
static set< string >	getAllAnalysisNames ()
static Analysis *	getAnalysis (const string &analysisname)
static vector< Analysis * >	getAllAnalyses ()
	Get all the available analyses.
Private Types
typedef map< string, const AnalysisBuilderBase * >	AnalysisBuilderMap
Static Private Member Functions
static void	_registerBuilder (const AnalysisBuilderBase *a)
	Register a new analysis builder.
static void	_loadAnalysisPlugins ()
	Load the available analyses at runtime.
Static Private Attributes
static AnalysisBuilderMap	_ptrs
Friends
class	AnalysisBuilderBase
	Allow the analysis builders to call the private _registerBuilder function.

---

Member Typedef Documentation

typedef map<string, const AnalysisBuilderBase*> AnalysisBuilderMap [private]

Definition at line 43 of file AnalysisLoader.hh.

---

Member Function Documentation

vector< string > analysisNames

(

)

[static]

Get all the available analyses' names.

Definition at line 16 of file AnalysisLoader.cc.

References AnalysisLoader::_loadAnalysisPlugins(), and AnalysisLoader::_ptrs.

Referenced by AnalysisLoader::getAllAnalysisNames().

                                               {
    _loadAnalysisPlugins();
    vector<string> names;
    foreach (const AnalysisBuilderMap::value_type& p, _ptrs) names += p.first;
    return names;
  }

set< string > getAllAnalysisNames

(

)

[static]

Definition at line 24 of file AnalysisLoader.cc.

References AnalysisLoader::analysisNames().

                                                  {
    set<string> anaset;
    vector<string> anas = analysisNames();
    foreach (const string &ana, anas) {
      anaset.insert(ana);
    }
    return anaset;
  }

Analysis * getAnalysis

(

const string &

analysisname

)

[static]

Get an analysis by name. Warning: a name arg which matches no known analysis will return a null pointer. Check your return values before using them!

Definition at line 34 of file AnalysisLoader.cc.

References AnalysisLoader::_loadAnalysisPlugins(), and AnalysisLoader::_ptrs.

                                                                  {
    _loadAnalysisPlugins();
    AnalysisBuilderMap::const_iterator ai = _ptrs.find(analysisname);
    if (ai == _ptrs.end()) return 0;
    return ai->second->mkAnalysis();
  }

vector< Analysis * > getAllAnalyses

(

)

[static]

Get all the available analyses.

Definition at line 42 of file AnalysisLoader.cc.

References AnalysisLoader::_loadAnalysisPlugins(), and AnalysisLoader::_ptrs.

                                                   {
    _loadAnalysisPlugins();
    vector<Analysis*> analyses;
    foreach (const AnalysisBuilderMap::value_type& p, _ptrs) {
      analyses += p.second->mkAnalysis();
    }
    return analyses;
  }

void _registerBuilder

(

const AnalysisBuilderBase *

a

)

[static, private]

Register a new analysis builder.

Todo:

Tidy this up!

Definition at line 52 of file AnalysisLoader.cc.

References AnalysisLoader::_ptrs, Log::ERROR, Log::getLog(), AnalysisBuilderBase::name(), and Log::TRACE.

Referenced by AnalysisBuilderBase::_register().

                                                                     {
    if (!ab) return;
    const string name = ab->name();
    if (_ptrs.find(name) != _ptrs.end()) {
      // Protect against overwriting analyses by throwing an error
      /// @todo Tidy this up!
      Log::getLog("Rivet.AnalysisLoader") << Log::ERROR << "Tried to register a second plugin analysis called '" << name << "'" << endl;
      exit(1);
    }
    Log::getLog("Rivet.AnalysisLoader") << Log::TRACE << "Registering a plugin analysis called '" << name << "'" << endl;
    _ptrs[name] = ab;
  }

void _loadAnalysisPlugins

(

)

[static, private]

Load the available analyses at runtime.

Todo:

Make sure this is an abs path

Todo:

Sys-dependent path separator instead of "/"

Definition at line 66 of file AnalysisLoader.cc.

References AnalysisLoader::_ptrs, Rivet::getLibPath(), Log::getLog(), directory::next(), Rivet::split(), Log::TRACE, and Log::WARN.

Referenced by AnalysisLoader::analysisNames(), AnalysisLoader::getAllAnalyses(), and AnalysisLoader::getAnalysis().

                                            {
    // Only run once
    if (!_ptrs.empty()) return;

    // Build the list of directories to search
    vector<string> dirs;
    char* env = 0;
    env = getenv("RIVET_ANALYSIS_PATH");
    if (env) {
      // Use the Rivet analysis path variable if set...
      dirs += split(env);
    } else {
      // ... otherwise fall back to the Rivet library install path
      dirs += getLibPath();
    }

    // Find plugin module library files
    const string libsuffix = ".so";
    vector<string> pluginfiles;
    foreach (const string& d, dirs) {
      if (d.empty()) continue;
      oslink::directory dir(d);
      while (dir) {
        string filename = dir.next();
        // Require that name *starts* with 'Rivet' with new loader
        if (filename.find("Rivet") != 0) continue;
        size_t posn = filename.find(libsuffix);
        if (posn == string::npos || posn != filename.length()-libsuffix.length()) continue;
        /// @todo Make sure this is an abs path
        /// @todo Sys-dependent path separator instead of "/"
        const string path = d + "/" + filename;
        // Ensure no duplicate paths
        if (find(pluginfiles.begin(), pluginfiles.end(), path) == pluginfiles.end()) {
          pluginfiles += path;
        }
      }
    }

    // Load the plugin files
    Log::getLog("Rivet.AnalysisLoader") << Log::TRACE << "Candidate analysis plugin libs: " << pluginfiles << endl;
    foreach (const string& pf, pluginfiles) {
      Log::getLog("Rivet.AnalysisLoader") << Log::TRACE << "Trying to load plugin analyses from file " << pf << endl;
      void* handle = dlopen(pf.c_str(), RTLD_LAZY);
      if (!handle) {
        Log::getLog("Rivet.AnalysisLoader") << Log::WARN << "Cannot open " << pf << ": " << dlerror() << endl;
        continue;
      }
    }
  }

---

Friends And Related Function Documentation

friend class AnalysisBuilderBase [friend]

Allow the analysis builders to call the private _registerBuilder function.

Definition at line 35 of file AnalysisLoader.hh.

---

Member Data Documentation

AnalysisLoader::AnalysisBuilderMap _ptrs [static, private]

Definition at line 44 of file AnalysisLoader.hh.

Referenced by AnalysisLoader::_loadAnalysisPlugins(), AnalysisLoader::_registerBuilder(), AnalysisLoader::analysisNames(), AnalysisLoader::getAllAnalyses(), and AnalysisLoader::getAnalysis().

---

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

• AnalysisLoader.hh
• AnalysisLoader.cc