ProcessStatisticsPython Class Reference

Python interface for ProcessStatistics. More...

#include <ProcessStatisticsPython.h>

Public Member Functions
ProcessStatistics *	getWrapped ()
	Get wrapped ProcessStatistics object.
std::string	getStatisticsString (ModuleStatistics::EStatisticCounters type=ModuleStatistics::c_Event, const std::vector< ModuleStatistics > *modules=nullptr)
	Return string with statistics for all modules. More...
std::string	getModuleStatistics (const boost::python::list &modulesPyList, ModuleStatistics::EStatisticCounters type=ModuleStatistics::c_Event)
	Return string with statistics for selected modules. More...
void	setModuleName (Module *module, const std::string &name)
	Set name for module in statistics. More...
const ModuleStatistics *	get (const std::shared_ptr< Module > &module)
	Get statistics for given module.
const ModuleStatistics *	getGlobal ()
	Get statistics for the framework itself.
boost::python::list	getAll ()
	Get statistics for all modules as python list.
void	clear ()
	Clear collected statistics but keep names of modules.

Static Public Member Functions
static ProcessStatisticsPython &	getInstance ()
	Return singleton instance of the statistics.
static void	exposePythonAPI ()
	Define python wrappers to make functionality avaiable in python.

Private Member Functions
	ProcessStatisticsPython ()=default
	Private constructor due to singleton pattern.
	ProcessStatisticsPython (const ProcessStatisticsPython &)=delete
	Prohibit copy constructor.
ProcessStatisticsPython &	operator= (ProcessStatisticsPython &)=delete
	Prohibit assignment operator.

Detailed Description

Python interface for ProcessStatistics.

Since ProcessStatistics itself resides in the data store, this wraps around it to export some functionality to python.

Definition at line 33 of file ProcessStatisticsPython.h.

Member Function Documentation

getModuleStatistics()

string getModuleStatistics	(	const boost::python::list &	modulesPyList,
		ModuleStatistics::EStatisticCounters	type = ModuleStatistics::c_Event
	)

Return string with statistics for selected modules.

Parameters

modulesPyList	python list of modules to show
type	counter type to use for statistics

Definition at line 49 of file ProcessStatisticsPython.cc.

{
  if (!getWrapped())
    return "";
 
  std::vector<ModuleStatistics> moduleStats;
  auto modules = PyObjConvUtils::convertPythonObject(modulesPyList, std::vector<ModulePtr>());
  for (const ModulePtr& ptr : modules) {
    ModuleStatistics& stats = getWrapped()->getStatistics(ptr.get());
    //Name could be empty if module has never been called
    if (stats.getName().empty()) stats.setName(ptr->getName());
    moduleStats.push_back(stats);
  }
  return getStatisticsString(mode, &moduleStats);
}

getStatisticsString()

string getStatisticsString	(	ModuleStatistics::EStatisticCounters	type = ModuleStatistics::c_Event,
		const std::vector< ModuleStatistics > *	modules = nullptr
	)

Return string with statistics for all modules.

Can be used in steering file with 'print statistics'.

Parameters

type	counter type to use for statistics
modules	map of modules to use. If NULL, default map will be used

Definition at line 41 of file ProcessStatisticsPython.cc.

setModuleName()

void setModuleName ( Module *  module, const std::string &  name  )

inline

Set name for module in statistics.

Normally, all modules get assigned their default name which is used to register them. If multiple instances of the same module are present at the same time, this can be used to distuingish between them

Parameters

module	Shared pointer to the Module for which a name is to be defined
name	Name to show in statistics

Definition at line 74 of file ProcessStatisticsPython.h.

    {
      getWrapped()->getStatistics(module).setName(name);
    }

---

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

• framework/pybasf2/include/ProcessStatisticsPython.h
• framework/pybasf2/src/ProcessStatisticsPython.cc