Belle II Software development
ModuleParamInfoPython.cc
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8
9#include <boost/python/class.hpp>
10
11#include <framework/core/ModuleParamInfoPython.h>
12
13using namespace std;
14using namespace Belle2;
15using namespace boost::python;
16
18{
19 //Python class definition
20 boost::python::class_<ModuleParamInfoPython>("ModuleParamInfo",
21 "Read only class to provide information about a module parameter")
22 .def_readonly("name", &ModuleParamInfoPython::m_name,
23 "Name of the Parameter")
24 .def_readonly("type", &ModuleParamInfoPython::m_typeName,
25 "Type of the Parameter as string")
26 .def_readonly("default", &ModuleParamInfoPython::m_defaultValues,
27 "Default value of the parameter")
28 .def_readonly("values", &ModuleParamInfoPython::m_values,
29 "Currently set value")
30 .def_readonly("description", &ModuleParamInfoPython::m_description,
31 "Description of the parameter")
32 .def_readonly("forceInSteering", &ModuleParamInfoPython::m_forceInSteering,
33 "If True this parameter has to be set for the module to work")
34 .def_readonly("setInSteering", &ModuleParamInfoPython::m_setInSteering,
35 "If True this parameter has been set to a specific value")
36 ;
37}
static void exposePythonAPI()
Exposes methods of the ModuleParam class to Python.
bool m_forceInSteering
If true the parameter has to be set by the user in the steering file.
bool m_setInSteering
True if the parameter was set in the steering file.
std::string m_description
The description of the parameter.
boost::python::list m_defaultValues
The default values of the parameter as a python list.
std::string m_name
The name of the parameter.
boost::python::list m_values
The values of the parameter as a python list.
std::string m_typeName
The name of the type of the parameter.
Abstract base class for different kinds of events.
STL namespace.