MaCh3PyBinder Class Reference

Base binder class which is used to set up python bindings. Experiments should derive from this to allow them to insert specialised classes into the pyMaCh3 module. More...

#include <python/pyMaCh3.h>

Public Member Functions
virtual	~MaCh3PyBinder ()
void	initialise (py::module &m)

Private Member Functions
void	initPlotting (py::module &m)
void	initFitters (py::module &m)
void	initSamples (py::module &m)
void	initManager (py::module &m)
void	initParameters (py::module &m)
void	initSplines (py::module &m)
virtual void	initParametersExperiment (py::module &m_parameters)
virtual void	initPlottingExperiment (py::module &m_plotting)
virtual void	initFittersExperiment (py::module &m_fitters)
virtual void	initSamplesExperiment (py::module &m_samples)
virtual void	initManagerExperiment (py::module &m_manager)
virtual void	initSplinesExperiment (py::module &m_splines)
virtual void	initModulesExperiment (py::module &m)

Detailed Description

Base binder class which is used to set up python bindings. Experiments should derive from this to allow them to insert specialised classes into the pyMaCh3 module.

Definition at line 19 of file pyMaCh3.h.

Constructor & Destructor Documentation

~MaCh3PyBinder()

virtual MaCh3PyBinder::~MaCh3PyBinder ( )

inlinevirtual

Definition at line 23 of file pyMaCh3.h.

{};

Member Function Documentation

initFitters()

void MaCh3PyBinder::initFitters ( py::module &  m )

inlineprivate

Definition at line 56 of file pyMaCh3.h.

                                  {
        auto m_fitters = m.def_submodule("fitters");
        m_fitters.doc() =
            "This is a Python binding of MaCh3s C++ fitters library.";
 
        initFittersModule(m_fitters); // <- defined in python/fitters.cpp
        initFittersExperiment(m_fitters);
    }

initFittersExperiment()

virtual void MaCh3PyBinder::initFittersExperiment ( py::module &  m_fitters )

inlineprivatevirtual

Definition at line 39 of file pyMaCh3.h.

{ (void)m_fitters;    }

initialise()

void MaCh3PyBinder::initialise ( py::module &  m )

inline

Definition at line 25 of file pyMaCh3.h.

                                 {
        initPlotting(m);
        initFitters(m);
        initSamples(m);
        initManager(m);
        initParameters(m);
        initSplines(m);
    }

initManager()

void MaCh3PyBinder::initManager ( py::module &  m )

inlineprivate

Definition at line 73 of file pyMaCh3.h.

                                  {
        auto m_manager = m.def_submodule("manager");
        m_manager.doc() = 
            "This is a Python binding of MaCh3s C++ based manager library.";
            
        initManagerModule(m_manager); // <- defined in python/manager.cpp
        initManagerExperiment(m_manager);
    }

initManagerExperiment()

virtual void MaCh3PyBinder::initManagerExperiment ( py::module &  m_manager )

inlineprivatevirtual

Definition at line 41 of file pyMaCh3.h.

{ (void)m_manager;    }

initModulesExperiment()

virtual void MaCh3PyBinder::initModulesExperiment ( py::module &  m )

inlineprivatevirtual

Definition at line 43 of file pyMaCh3.h.

{ (void)m;            }

initParameters()

void MaCh3PyBinder::initParameters ( py::module &  m )

inlineprivate

Definition at line 81 of file pyMaCh3.h.

                                     {
        auto m_parameters = m.def_submodule("parameters");
        m_parameters.doc() =
            "This is a Python binding of MaCh3s C++ parameters library.";
 
        initParametersModule(m_parameters); // <- defined in python/parameters.cpp
        initParametersExperiment(m_parameters);
    }

initParametersExperiment()

virtual void MaCh3PyBinder::initParametersExperiment ( py::module &  m_parameters )

inlineprivatevirtual

Definition at line 37 of file pyMaCh3.h.

{ (void)m_parameters; }

initPlotting()

void MaCh3PyBinder::initPlotting ( py::module &  m )

inlineprivate

Definition at line 49 of file pyMaCh3.h.

                                   {
        auto m_plotting = m.def_submodule("plotting");
        m_plotting.doc() = "This is a Python binding of MaCh3s C++ based plotting library.";
 
        initPlottingModule(m_plotting); // <- defined in python/plotting.cpp
        initPlottingExperiment(m_plotting);
    }

initPlottingExperiment()

virtual void MaCh3PyBinder::initPlottingExperiment ( py::module &  m_plotting )

inlineprivatevirtual

Definition at line 38 of file pyMaCh3.h.

{ (void)m_plotting;   }

initSamples()

void MaCh3PyBinder::initSamples ( py::module &  m )

inlineprivate

Definition at line 64 of file pyMaCh3.h.

                                  {
        auto m_samples = m.def_submodule("samples");
 
        m_samples.doc() =
            "This is a Python binding of MaCh3s C++ based samples library.";
            
        initSamplesModule(m_samples); // <- defined in python/samples.cpp
        initSamplesExperiment(m_samples);
    }

initSamplesExperiment()

virtual void MaCh3PyBinder::initSamplesExperiment ( py::module &  m_samples )

inlineprivatevirtual

Definition at line 40 of file pyMaCh3.h.

{ (void)m_samples;    }

initSplines()

void MaCh3PyBinder::initSplines ( py::module &  m )

inlineprivate

Definition at line 89 of file pyMaCh3.h.

                                  {
        auto m_splines = m.def_submodule("splines");
        m_splines.doc() = 
            "This is a Python binding of MaCh3s C++ based spline library.";
 
        initSplinesModule(m_splines); // <- defined in python/splines.cpp
        initSplinesExperiment(m_splines);
    }

initSplinesExperiment()

virtual void MaCh3PyBinder::initSplinesExperiment ( py::module &  m_splines )

inlineprivatevirtual

Definition at line 42 of file pyMaCh3.h.

{ (void)m_splines;    }

---

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

• python/pyMaCh3.h