Path.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 <framework/core/PathElement.h>
#include <memory>
#include <list>
 
namespace boost {
  namespace python {
    class list;
  }
}
 
namespace Belle2 {
  class Path;
  class Module;
 
  //------------------------------------------------------
  //             Define convenient typdefs
  //------------------------------------------------------
 
  typedef std::shared_ptr<Path> PathPtr;
 
  class Path : public PathElement {
 
  public:
 
    Path();
 
    ~Path();
 
    void addModule(const std::shared_ptr<Module>& module);
 
    bool isEmpty() const;
 
    std::list<std::shared_ptr<Module> > getModules() const override;
 
    std::list<std::shared_ptr<Module> > buildModulePathList(bool unique = true) const;
 
    void putModules(const std::list<std::shared_ptr<Module> >& mlist);
 
    bool contains(const std::string& moduleType) const;
 
    std::shared_ptr<PathElement> clone() const override;
 
 
    //--------------------------------------------------
    //                   Python API
    //--------------------------------------------------
 
    void addPath(const PathPtr& path);
 
    void forEach(const std::string& loopObjectName, const std::string& arrayName, PathPtr path);
 
    void doWhile(PathPtr path, const std::string& condition, unsigned int maxIterations);
 
    void addIndependentPath(const PathPtr& independent_path, std::string ds_ID, const boost::python::list& merge_back);
 
    std::string getPathString() const override;
 
    static void exposePythonAPI();
 
 
  private:
 
    std::list<std::shared_ptr<PathElement> > m_elements; 
    friend class PathIterator;
  };
 
} // end namespace Belle2