Class to store basic information about a parameter. More...

#include <ModuleParamInfoPython.h>

Collaboration diagram for ModuleParamInfoPython:

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the ModuleParam class to Python.

Public Attributes
std::string	m_name
	The name of the parameter.

std::string	m_typeName
	The name of the type of the parameter.

boost::python::list	m_defaultValues
	The default values of the parameter as a python list.

boost::python::list	m_values
	The values of the parameter as a python list.

std::string	m_description
	The description of the parameter.

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.

Detailed Description

Class to store basic information about a parameter.

This class is used in the Python API to provide the user with information about a parameter.

Definition at line 24 of file ModuleParamInfoPython.h.

Member Function Documentation

◆ exposePythonAPI()

void exposePythonAPI ( )

static

Exposes methods of the ModuleParam class to Python.

Definition at line 17 of file ModuleParamInfoPython.cc.

{
  //Python class definition
  boost::python::class_<ModuleParamInfoPython>("ModuleParamInfo",
                                               "Read only class to provide information about a module parameter")
  .def_readonly("name", &ModuleParamInfoPython::m_name,
                "Name of the Parameter")
  .def_readonly("type", &ModuleParamInfoPython::m_typeName,
                "Type of the Parameter as string")
  .def_readonly("default", &ModuleParamInfoPython::m_defaultValues,
                "Default value of the parameter")
  .def_readonly("values", &ModuleParamInfoPython::m_values,
                "Currently set value")
  .def_readonly("description", &ModuleParamInfoPython::m_description,
                "Description of the parameter")
  .def_readonly("forceInSteering", &ModuleParamInfoPython::m_forceInSteering,
                "If True this parameter has to be set for the module to work")
  .def_readonly("setInSteering", &ModuleParamInfoPython::m_setInSteering,
                "If True this parameter has been set to a specific value")
  ;
}

Member Data Documentation

◆ m_defaultValues

boost::python::list m_defaultValues

The default values of the parameter as a python list.

Definition at line 30 of file ModuleParamInfoPython.h.

◆ m_description

std::string m_description

The description of the parameter.

Definition at line 32 of file ModuleParamInfoPython.h.

◆ m_forceInSteering

bool m_forceInSteering

If true the parameter has to be set by the user in the steering file.

Definition at line 33 of file ModuleParamInfoPython.h.

◆ m_name

std::string m_name

The name of the parameter.

Definition at line 28 of file ModuleParamInfoPython.h.

◆ m_setInSteering

bool m_setInSteering

True if the parameter was set in the steering file.

Definition at line 34 of file ModuleParamInfoPython.h.

◆ m_typeName

std::string m_typeName

The name of the type of the parameter.

Definition at line 29 of file ModuleParamInfoPython.h.

◆ m_values

boost::python::list m_values

The values of the parameter as a python list.

Definition at line 31 of file ModuleParamInfoPython.h.

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

framework/core/include/ModuleParamInfoPython.h
framework/core/src/ModuleParamInfoPython.cc

Static Public Member Functions

Public Attributes