FdLightCollectionEfficiencyKG::SubModule Class Reference

Adaptor class for FdLightCollectionEfficiency's sub-modules for initializing, running, timing them. More...

#include <SubModule.h>

Public Member Functions
fwk::VModule::ResultFlag	Finish ()

fwk::VModule &	GetModule ()

const std::string &	GetName () const

int	GetVerbosity ()

fwk::VModule::ResultFlag	Init ()

void	PrintTiming (utl::TabularStream &tabStream)
	Prints the sub-module timing to the given tabular stream. More...

fwk::VModule::ResultFlag	Run (evt::Event &event)

void	SetVerbosity (const int verbosity)

	SubModule (const std::string &moduleName, const int verbosity=1)

	SubModule ()

	~SubModule ()

Static Public Member Functions
static void	FinishTimingPrintout (utl::TabularStream &tabStream)
	Finishes the printout and actually dumps it to stdout. More...

static utl::TabularStream	TimingHeader ()
	Prepares a TabularStream for timing printout. More...

Private Member Functions
fwk::VModule::ResultFlag	ReportStatus (const fwk::VModule::ResultFlag status)
	Utility function to report non-success result of module invocations. More...

Private Attributes
bool	fInitialized

std::string	fModuleName

utl::Stopwatch	fStopWatch

int	fVerbosity
	global verbosity flag More...

Detailed Description

Adaptor class for FdLightCollectionEfficiency's sub-modules for initializing, running, timing them.

Author: Steffen Mueller

Date: Fri Jan 29 11:01:00 CET 2010

Definition at line 34 of file SubModule.h.

Constructor & Destructor Documentation

SubModule::SubModule	(	const std::string &	moduleName,
		const int	verbosity = `1`
	)

Definition at line 29 of file SubModule.cc.

FdLightCollectionEfficiencyKG::SubModule::~SubModule ( )

inline

Definition at line 38 of file SubModule.h.

FdLightCollectionEfficiencyKG::SubModule::SubModule ( )

inline

Definition at line 39 of file SubModule.h.

Member Function Documentation

fwk::VModule::ResultFlag SubModule::Finish ( void )

Definition at line 51 of file SubModule.cc.

References fwk::VModule::Finish(), fModuleName, fVerbosity, and GetModule().

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Finish().

void SubModule::FinishTimingPrintout ( utl::TabularStream & tabStream )

static

Finishes the printout and actually dumps it to stdout.

Definition at line 111 of file SubModule.cc.

References utl::hline(), and INFO.

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Finish().

fwk::VModule & SubModule::GetModule ( )

Definition at line 61 of file SubModule.cc.

References fModuleName, and fwk::RunController::GetModule().

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::DoInitialReconstruction(), Finish(), Init(), Run(), and FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::RunPhotonGenerationRayTracingLoop().

const std::string& FdLightCollectionEfficiencyKG::SubModule::GetName ( ) const

inline

Definition at line 48 of file SubModule.h.

References fModuleName.

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Finish(), FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Init(), PrintTiming(), ReportStatus(), and Run().

int FdLightCollectionEfficiencyKG::SubModule::GetVerbosity ( )

inline

Definition at line 42 of file SubModule.h.

References fVerbosity.

fwk::VModule::ResultFlag SubModule::Init ( void )

Definition at line 39 of file SubModule.cc.

References fInitialized, fModuleName, fStopWatch, fVerbosity, GetModule(), fwk::VModule::Init(), and utl::Stopwatch::Reset().

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Init().

void SubModule::PrintTiming ( utl::TabularStream & tabStream )

Prints the sub-module timing to the given tabular stream.

Definition at line 89 of file SubModule.cc.

References utl::endc, utl::endr, fStopWatch, utl::Stopwatch::GetCPUTime(), GetName(), and galactic::second.

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Finish().

VModule::ResultFlag SubModule::ReportStatus ( const fwk::VModule::ResultFlag status )

private

Utility function to report non-success result of module invocations.

Definition at line 122 of file SubModule.cc.

References io::eSuccess, GetName(), and WARNING.

Referenced by Run().

fwk::VModule::ResultFlag SubModule::Run ( evt::Event & event )

Definition at line 70 of file SubModule.cc.

References ERROR, fInitialized, fModuleName, fStopWatch, fVerbosity, GetModule(), GetName(), ReportStatus(), fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::DoInitialReconstruction(), FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::ProcessEvent(), and FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::RunPhotonGenerationRayTracingLoop().

void FdLightCollectionEfficiencyKG::SubModule::SetVerbosity ( const int verbosity )

inline

Definition at line 41 of file SubModule.h.

References fVerbosity.

utl::TabularStream SubModule::TimingHeader ( )

static

Prepares a TabularStream for timing printout.

Definition at line 101 of file SubModule.cc.

References utl::endc, utl::endr, and utl::hline().

Referenced by FdLightCollectionEfficiencyKG::FdLightCollectionEfficiency::Finish().

Member Data Documentation

bool FdLightCollectionEfficiencyKG::SubModule::fInitialized

private

Definition at line 68 of file SubModule.h.

Referenced by Init(), and Run().

std::string FdLightCollectionEfficiencyKG::SubModule::fModuleName

private

Definition at line 67 of file SubModule.h.

Referenced by Finish(), GetModule(), GetName(), Init(), and Run().

utl::Stopwatch FdLightCollectionEfficiencyKG::SubModule::fStopWatch

private

Definition at line 66 of file SubModule.h.

Referenced by Init(), PrintTiming(), and Run().

int FdLightCollectionEfficiencyKG::SubModule::fVerbosity

private

global verbosity flag

Definition at line 64 of file SubModule.h.

Referenced by Finish(), GetVerbosity(), Init(), Run(), and SetVerbosity().

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

, generated on Tue Sep 26 2023.