Framework.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <boost/python/list.hpp>
#include <boost/python/dict.hpp>
 
#include <framework/core/Module.h>
#include <framework/core/Path.h>
#include <framework/gearbox/Const.h>
 
#include <string>
 
namespace Belle2 {
  class Framework {
  public:
    Framework();
 
    virtual ~Framework();
 
    static void addModuleSearchPath(const std::string& path);
 
    static void setExternalsPath(const std::string& path);
 
    static ModulePtr registerModule(const std::string& moduleName);
 
    static ModulePtr registerModule(const std::string& moduleName, const std::string& sharedLibPath);
 
    static void process(PathPtr startPath, long maxEvent = 0);
 
    static void setNumberProcesses(int numProcesses);
 
    static int getNumberProcesses();
 
    static void setPicklePath(const std::string& path);
 
    static std::string getPicklePath();
 
    static void setStreamingObjects(const boost::python::list& streamingObjects);
 
    static void setRealm(const std::string& realm);
 
    static void setRunType(const Const::ERunType runType);
 
    static void setCosmicRun();
 
    static void setBeamRun();
 
    static void writeSimulationSteps();
 
    static std::string findFile(const std::string& filename, const std::string& type, bool ignore_errors = false);
 
    //--------------------------------------------------
    //                   Python API
    //--------------------------------------------------
 
    static boost::python::list getModuleSearchPathsPython();
 
    static boost::python::dict getAvailableModulesPython();
 
    static boost::python::list getRegisteredModulesPython();
 
    static void exposePythonAPI();
  };
 
} //end of namespace Belle2