Base class for modules. More...

Inheritance diagram for QBaseModule:

Public Types
enum	Type { Module , Filter , Reader , Writer , Driver }

Public Member Functions
	QBaseModule (Type type)
	constructor More...

virtual	~QBaseModule ()
	constructor More...

double	GetDouble (const std::string &parname, double defVal, bool warnCfg=true) const
	Get a double parameter from config file. More...

std::vector< double >	GetVectorDouble (const std::string &parname, std::vector< double > defVal, bool warnCfg=true) const
	Get a std::vector<double> parameter from config file with syntax "{x,y,z}". More...

int	GetInt (const std::string &parname, int defVal, bool warnCfg=true) const
	Get an int parameter from config file ( see GetDouble() ) More...

std::vector< int >	GetVectorInt (const std::string &parname, std::vector< int > defVal, bool warnCfg=true) const
	Get an vector<int> parameter from config file ( see GetVectorDouble() ) More...

bool	GetBool (const std::string &parname, bool defVal, bool warnCfg=true) const
	Get a bool parameter from config file ( see GetDouble() ) More...

std::vector< bool >	GetVectorBool (const std::string &parname, std::vector< bool > defVal, bool warnCfg=true) const
	Get a vector<bool> parameter from config file ( see GetVectorDouble() ) More...

const std::string &	GetString (const std::string &parname, const std::string &defVal, bool warnCfg=true) const
	Get a string parameter from config file ( see GetDouble() ) More...

std::vector< std::string >	GetVectorString (const std::string &parname, std::vector< std::string > defVal, bool warnCfg=true) const
	Get a vector<string> parameter from config file ( see GetVectorDouble() ) More...

void	Debug (const char *descr,...) const
	Send a debug message (used to debug the module) with printf syntax. More...

void	Info (const char *descr,...) const
	Send an info message (information) with printf syntax. More...

void	Warn (const char *descr,...) const
	Send a warning message (an error that the framework can recover) with printf syntax. More...

void	Error (const char *descr,...) const
	Send an error message (an error that the framework cannot recover) with printf syntax. More...

void	Panic (const char *descr,...) const
	Send a panic message (stops the framework) with printf syntax. More...

const QGlobalDataManager &	GlobalData () const
	interface for saving and loading global QObjects More...

bool	GetRunAgain () const
	Check if the sequence will be reiterated. More...

void	SetRunAgain (bool b)
	Set that the sequence will be reiterated. More...

unsigned int	GetIteration () const
	Get Current sequence iteration. More...

unsigned int	GetOccurrence () const
	get the number of times the same module is loaded inside a QSequence More...

bool	isEnabled () const
	check if module is enabled More...

std::string	GetFullPath () const
	Get Full Path of module "GetName() + "." + GetOccurrence". More...

const std::string &	GetName () const
	Get Module name. More...

const std::string &	GetLabel () const
	Get Module name + the optional ExtraLabel ("name_extralabel") More...

MsgLevel	GetVerbosity ()
	get verbosity level set from config file More...

const QSequence &	GetSequence () const
	get reference to this sequence More...

void	Update (QSequence *s, unsigned int occurrence)
	set the occurrence in the same sequence. MV FIXME: should not be public More...

bool	NeedNeighbours ()
	check wheter this module needs neighbours (available after the first event is processed) More...

void	BeginBase (QEventAssembler &ev)
	Begin Base method is called before event loop. More...

virtual void	Begin (QEventAssembler &ev)=0
	Begin method is called before event loop and must be implemented by inheriting classes. More...

bool	ProcessBase (QEventAssembler &ev, QEventList &evl, const bool exec, QEventList &ovl)
	ProcessBase method is called for each event, getting the event and as argument. More...

virtual bool	Process (QEventAssembler &ev, QEventList &evl, const bool exec, QEventList &ovl)=0
	Process method is called for each event, getting the event and as argument and must be implemented by inheriting classes. More...

void	EndBase ()
	EndBase method is called after event loop. More...

virtual void	End ()=0
	End method is called after event loop and must be implemented by inheriting classes. More...

const std::vector< QEventLabel > &	GetRequiredLabels () const
	Get labels of objects required by this module. More...

Protected Member Functions
QModuleConfig &	GetConfig ()
	Get module config. More...

void	SetNeedNeighbours (bool need)
	set wheter this module needs neighbours More...

Protected Member Functions inherited from QModuleTimeProfiling
	QModuleTimeProfiling ()
	ctor initialized internal variables More...

virtual	~QModuleTimeProfiling ()
	dtor does nothing More...

void	SetTimeProfilingOn (bool val)
	Set the time profiling on/off. More...

bool	GetTimeProfilingOn () const
	Check if the time profiling is on. More...

void	ResetTimer ()
	Reset the timer to now. More...

double	GetTimer () const
	return the time since the last reset More...

virtual void	StartProcessCall ()
	Start of a process call. More...

virtual void	EndProcessCall ()
	End a process call and increment time and calls. More...

unsigned long long	GetProcessCalls () const
	Return the total number of process calls. More...

double	GetTotalProcessTime () const
	Return the total processing time. More...

double	GetProcessCallTime () const
	Return the average time of a single process call. More...

std::string	GetTimeProfileReport (const std::string &prefix="") const
	Report the time profiling. More...

Protected Attributes
bool	fExecuted

Protected Attributes inherited from QModuleTimeProfiling
bool	fTimeProfilingOn
	Report the time profiling. More...

unsigned long long int	fProcessCalls
	NUmber of calls to the process. More...

double	fProcessTime
	Total time spent running the process. More...

Private Member Functions
void	UpdateEnableFlag ()
	update enable flag More...

void	Disable ()
	disable More...

void	UpdateConfigParameters (const std::string &p) const
	update module config More...

void	SetVerbosity (MsgLevel l=WarnMsg)

Private Attributes
MsgLevel	verbosity

unsigned int	fOccurrence

bool	fEnabled

std::string	fLabel

std::string	fName

std::string	fMessageName

bool	fFirstCall

bool	fNeedNeighbours

QSequence *	my_sequence

QModuleConfig	fConfig

Type	fType

std::vector< QEventLabel >	fRequiredLabels

Friends
template<class T >
class	QModFactory

class	QModuleFactory

class	QSequence

class	QModule

class	QWriter

class	QDriver

class	QFilter

Detailed Description

Base class for modules.

Author: M. Pallavicini, M. Vignati

This class implements general methods that are used by all modules, such as config file parameters and interfaces to check and control the sequence execution. This class define the following config file parameters:

Parameters:
- enable [bool]: if true the module will be executed inside the sequence, if false module it will not be executed.
- verbosity [info]: only messages above the verbosity level are displayed on screen and in the log file:
  - debug: debug information.
  - info : normal information.
  - warn : error that has been recovered.
  - error: error that has not been recovered.
  - panic: error that stops the program execution (quit diana).

Optional Parameters:

ExtraLabel [string = ""]: Append to the module name an extra label. All the quantities set in QEvent and in QGlobalDataManager will have "ModuleName_ExtraLabel" as owner
OverWriteEvent [bool = false]: OverWrite quantities previously set by this module. If one runs the same module twice (e.g. in two different sequences, reading the output of the first sequence in the second one) the QEvent will throw an error if the module adds to the QEvent the same QObject. This option allows to overwrite the previously set QObject. Alternatively one can set in the first or second module the ExtraLabel (see above), in order to preserve both objects with different owners.
TimeProfilingOn [bool = false]: estimate the average time (microseconds) spent on processing a QEvent.

Each module type have to inherit from this base class that is managed by the QSequence through the BeginBase(), ProcessBase() and EndBase() methods.

Definition at line 57 of file QBaseModule.hh.

Member Enumeration Documentation

◆ Type

enum QBaseModule::Type

Enumerator
Module
Filter
Reader
Writer
Driver

Definition at line 60 of file QBaseModule.hh.

Constructor & Destructor Documentation

◆ QBaseModule()

Q_BEGIN_NAMESPACE QBaseModule::QBaseModule ( Type type )

constructor

Definition at line 18 of file QBaseModule.cc.

References fEnabled, fMessageName, fName, fNeedNeighbours, fOccurrence, fType, verbosity, and WarnMsg.

◆ ~QBaseModule()

QBaseModule::~QBaseModule ( )

virtual

constructor

Definition at line 30 of file QBaseModule.cc.

Member Function Documentation

◆ Begin()

virtual void QBaseModule::Begin ( QEventAssembler & ev )

pure virtual

Begin method is called before event loop and must be implemented by inheriting classes.

Implemented in QReader, QModule, QDriver, QWriter, and QFilter.

Referenced by BeginBase().

◆ BeginBase()

void QBaseModule::BeginBase ( QEventAssembler & ev )

Begin Base method is called before event loop.

Definition at line 74 of file QBaseModule.cc.

References Begin(), DebugMsg, ErrorMsg, fConfig, QModuleConfig::fLabel, fLabel, fName, fNeedNeighbours, QModuleTimeProfiling::fProcessCalls, QModuleTimeProfiling::fProcessTime, fRequiredLabels, GetBool(), QOptions::GetBool(), QOptions::GetInstance(), GetIteration(), QEventAssembler::GetRequiredLabels(), GetString(), QSequence::GlobalData(), InfoMsg, my_sequence, PanicMsg, QEventAssembler::SetOverWrite(), QGlobalDataManager::SetOwner(), QEventAssembler::SetOwner(), QEventAssembler::SetRequiredLabels(), QModuleTimeProfiling::SetTimeProfilingOn(), verbosity, Warn(), and WarnMsg.

Referenced by QSequence::Run().

◆ Debug()

void QBaseModule::Debug	(	const char *	descr,
			...
	)		const

inline

Send a debug message (used to debug the module) with printf syntax.

Definition at line 208 of file QBaseModule.hh.

References DebugMsg, fMessageName, QMessageHandler::Get(), QMessageHandler::Send(), and verbosity.

Referenced by QFilter::Begin(), QModule::Begin(), QFileWriter::Do(), QFileWriter::Done(), MFlagCoincidence::Init(), QFileReader::Init(), QReader::InitFileManager(), and QReader::ReadFilesList().

◆ Disable()

void QBaseModule::Disable ( )

inlineprivate

disable

Definition at line 176 of file QBaseModule.hh.

References fEnabled.

◆ End()

virtual void QBaseModule::End ( )

pure virtual

End method is called after event loop and must be implemented by inheriting classes.

Implemented in QWriter, QReader, QModule, QFilter, and QDriver.

Referenced by EndBase().

◆ EndBase()

void QBaseModule::EndBase ( )

EndBase method is called after event loop.

Definition at line 162 of file QBaseModule.cc.

References End(), fLabel, fNeedNeighbours, QModuleTimeProfiling::fProcessCalls, QModuleTimeProfiling::GetTimeProfileReport(), QModuleTimeProfiling::GetTimeProfilingOn(), QSequence::GlobalData(), Info(), my_sequence, and QGlobalDataManager::SetOwner().

Referenced by QSequence::Run().

◆ Error()

void QBaseModule::Error	(	const char *	descr,
			...
	)		const

inline

Send an error message (an error that the framework cannot recover) with printf syntax.

Definition at line 238 of file QBaseModule.hh.

References ErrorMsg, fMessageName, QMessageHandler::Get(), QMessageHandler::Send(), and verbosity.

Referenced by QFilter::Begin(), QDriver::Begin(), MTimeSort::Do(), QFilter::End(), and QDriver::HandleAction().

◆ GetBool()

bool QBaseModule::GetBool	(	const std::string &	parname,
		bool	defVal,
		bool	warnCfg = `true`
	)		const

Get a bool parameter from config file ( see GetDouble() )

Definition at line 256 of file QBaseModule.cc.

References QOptions::GetBool(), QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

Referenced by QFilter::Begin(), QWriter::Begin(), QDriver::Begin(), QModule::Begin(), QReader::Begin(), BeginBase(), MCoincidenceVeto::GetCuts(), QTriggerThreshold::GetParametersFromCFG(), QTriggerTTL::GetParametersFromCFG(), MCoincidenceMultiplicity::Init(), MCoincidenceTiming::Init(), QNeighboursFiller::Init(), QFileWriter::Init(), and UpdateEnableFlag().

◆ GetConfig()

QModuleConfig& QBaseModule::GetConfig ( )

inlineprotected

Get module config.

Definition at line 166 of file QBaseModule.hh.

References fConfig.

◆ GetDouble()

double QBaseModule::GetDouble	(	const std::string &	parname,
		double	defVal,
		bool	warnCfg = `true`
	)		const

Get a double parameter from config file.

Parameters

parname	name of the parameter as it appears in the config file.
defval	default return value if the parameter is not found in the config file.
warnCfg	send a warn message if the parameter is not found in the config file.

Definition at line 184 of file QBaseModule.cc.

References QOptions::GetDouble(), QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

Referenced by MCoincidenceVeto::GetCuts(), QTriggerBULLDAQ::GetParametersFromCFG(), QTriggerNoise::GetParametersFromCFG(), QTriggerOptimumFilter::GetParametersFromCFG(), QTriggerThreshold::GetParametersFromCFG(), QTriggerTTL::GetParametersFromCFG(), MCoincidenceMultiplicity::Init(), MCoincidenceTiming::Init(), MFlagCoincidence::Init(), and QTimeNeighbour::Init().

◆ GetFullPath()

std::string QBaseModule::GetFullPath ( ) const

Get Full Path of module "GetName() + "." + GetOccurrence".

Definition at line 177 of file QBaseModule.cc.

References GetName(), and GetOccurrence().

◆ GetInt()

int QBaseModule::GetInt	(	const std::string &	parname,
		int	defVal,
		bool	warnCfg = `true`
	)		const

Get an int parameter from config file ( see GetDouble() )

Definition at line 219 of file QBaseModule.cc.

References QOptions::GetInstance(), QOptions::GetInt(), GetName(), GetOccurrence(), GetSequence(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

Referenced by QModule::Begin(), QReader::Begin(), QTriggerOptimumFilter::GetParametersFromCFG(), QNeighboursFiller::Init(), and QFileWriter::Init().

◆ GetIteration()

unsigned int QBaseModule::GetIteration ( ) const

inline

Get Current sequence iteration.

Definition at line 122 of file QBaseModule.hh.

References QSequence::GetIteration(), and my_sequence.

Referenced by QModule::Begin(), BeginBase(), MCoincidenceMultiplicity::Do(), MCoincidenceTiming::Do(), QFileWriter::Done(), MCoincidenceTiming::Done(), QModule::End(), MCoincidenceMultiplicity::Init(), MCoincidenceTiming::Init(), MFlagCoincidence::Init(), MTimeSort::Init(), QFileReader::Init(), QFileWriter::Init(), QReader::InitFileManager(), and QModule::Process().

◆ GetLabel()

const std::string& QBaseModule::GetLabel ( ) const

inline

Get Module name + the optional ExtraLabel ("name_extralabel")

Definition at line 133 of file QBaseModule.hh.

References fLabel.

◆ GetName()

const std::string& QBaseModule::GetName ( ) const

inline

Get Module name.

Definition at line 131 of file QBaseModule.hh.

References fName.

Referenced by QReader::Begin(), QSequence::CheckModuleWithNeighbours(), QSequence::Dump(), GetBool(), GetDouble(), QSequence::GetDriverName(), GetFullPath(), GetInt(), QDriver::GetModuleParameters(), QSequence::GetReaderName(), GetString(), GetVectorBool(), GetVectorDouble(), GetVectorInt(), GetVectorString(), QSequence::GetWriterName(), QFileReader::JumpToEvent(), QSequence::JumpToEvent(), QReader::JumpToEvent(), Update(), and UpdateConfigParameters().

◆ GetOccurrence()

unsigned int QBaseModule::GetOccurrence ( ) const

inline

get the number of times the same module is loaded inside a QSequence

Definition at line 125 of file QBaseModule.hh.

References fOccurrence.

Referenced by GetBool(), GetDouble(), GetFullPath(), GetInt(), GetString(), GetVectorBool(), GetVectorDouble(), GetVectorInt(), GetVectorString(), QModuleFactory::Init(), Update(), and UpdateConfigParameters().

◆ GetRequiredLabels()

const std::vector<QEventLabel>& QBaseModule::GetRequiredLabels ( ) const

inline

Get labels of objects required by this module.

Definition at line 159 of file QBaseModule.hh.

References fRequiredLabels.

Referenced by QFilter::FilterAlgorithm(), and QModule::Process().

◆ GetRunAgain()

bool QBaseModule::GetRunAgain ( ) const

inline

Check if the sequence will be reiterated.

Definition at line 118 of file QBaseModule.hh.

References QSequence::GetRunAgain(), and my_sequence.

Referenced by QFileWriter::Done().

◆ GetSequence()

const QSequence& QBaseModule::GetSequence ( ) const

inline

get reference to this sequence

Definition at line 137 of file QBaseModule.hh.

References my_sequence.

Referenced by GetBool(), GetDouble(), GetInt(), GetString(), GetVectorBool(), GetVectorDouble(), GetVectorInt(), GetVectorString(), GlobalData(), Update(), and UpdateConfigParameters().

◆ GetString()

const std::string & QBaseModule::GetString	(	const std::string &	parname,
		const std::string &	defVal,
		bool	warnCfg = `true`
	)		const

Get a string parameter from config file ( see GetDouble() )

Definition at line 297 of file QBaseModule.cc.

References QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::GetString(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

Referenced by QFilter::Begin(), QReader::Begin(), BeginBase(), QFileWriter::BuildFileName(), QTriggerOptimumFilter::GetParametersFromCFG(), MCoincidenceMultiplicity::Init(), MCoincidenceTiming::Init(), MFlagCoincidence::Init(), MSorter::Init(), MTimeEnergy::Init(), MTimeSort::Init(), QTimeNeighbour::Init(), QFileReader::Init(), QNeighboursFiller::Init(), QReaderEventGeneratorFiller::Init(), QFileWriter::Init(), QReader::InitFileManager(), and QFileWriter::WriteFilesList().

◆ GetVectorBool()

std::vector< bool > QBaseModule::GetVectorBool	(	const std::string &	parname,
		std::vector< bool >	defVal,
		bool	warnCfg = `true`
	)		const

Get a vector<bool> parameter from config file ( see GetVectorDouble() )

Definition at line 270 of file QBaseModule.cc.

References QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::GetVectorBool(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

◆ GetVectorDouble()

std::vector< double > QBaseModule::GetVectorDouble	(	const std::string &	parname,
		std::vector< double >	defVal,
		bool	warnCfg = `true`
	)		const

Get a std::vector<double> parameter from config file with syntax "{x,y,z}".

Parameters

parname	name of the parameter as it appears in the config file.
defval	default return value if the parameter is not found in the config file.
warnCfg	send a warn message if the parameter is not found in the config file.

Definition at line 199 of file QBaseModule.cc.

References QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::GetVectorDouble(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

◆ GetVectorInt()

std::vector< int > QBaseModule::GetVectorInt	(	const std::string &	parname,
		std::vector< int >	defVal,
		bool	warnCfg = `true`
	)		const

Get an vector<int> parameter from config file ( see GetVectorDouble() )

Definition at line 234 of file QBaseModule.cc.

References QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::GetVectorInt(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

◆ GetVectorString()

std::vector< std::string > QBaseModule::GetVectorString	(	const std::string &	parname,
		std::vector< std::string >	defVal,
		bool	warnCfg = `true`
	)		const

Get a vector<string> parameter from config file ( see GetVectorDouble() )

Definition at line 313 of file QBaseModule.cc.

References QOptions::GetInstance(), GetName(), GetOccurrence(), GetSequence(), QOptions::GetVectorString(), QOptions::SetParameter(), UpdateConfigParameters(), and Warn().

Referenced by QCreateSidePulseByPulseSplitting::Init().

◆ GetVerbosity()

MsgLevel QBaseModule::GetVerbosity ( )

inline

get verbosity level set from config file

Definition at line 135 of file QBaseModule.hh.

References verbosity.

◆ GlobalData()

const QGlobalDataManager& QBaseModule::GlobalData ( ) const

inline

interface for saving and loading global QObjects

Definition at line 116 of file QBaseModule.hh.

References GetSequence(), and QSequence::GlobalData().

Referenced by QFileWriter::BuildFileName(), and QFileWriter::Do().

◆ Info()

void QBaseModule::Info	(	const char *	descr,
			...
	)		const

inline

Send an info message (information) with printf syntax.

Definition at line 218 of file QBaseModule.hh.

References fMessageName, QMessageHandler::Get(), InfoMsg, QMessageHandler::Send(), and verbosity.

Referenced by QFilter::Begin(), QDriver::Begin(), QModule::Begin(), QFileReader::Do(), MCoincidenceTiming::Do(), QFileWriter::Do(), QFilter::End(), QReader::End(), EndBase(), MFlagCoincidence::Init(), MSorter::Init(), and QReader::Process().

◆ isEnabled()

bool QBaseModule::isEnabled ( ) const

inline

check if module is enabled

Definition at line 127 of file QBaseModule.hh.

References fEnabled.

Referenced by QSequence::Dump(), QSequence::Run(), and QSequence::~QSequence().

◆ NeedNeighbours()

bool QBaseModule::NeedNeighbours ( )

inline

check wheter this module needs neighbours (available after the first event is processed)

Definition at line 141 of file QBaseModule.hh.

References fNeedNeighbours.

Referenced by QSequence::CheckModuleWithNeighbours().

◆ Panic()

void QBaseModule::Panic	(	const char *	descr,
			...
	)		const

inline

Send a panic message (stops the framework) with printf syntax.

Definition at line 248 of file QBaseModule.hh.

References fMessageName, QMessageHandler::Get(), PanicMsg, QMessageHandler::Send(), and verbosity.

Referenced by QReader::BaseJumpToEvent(), QModule::Begin(), QFileWriter::BuildFileName(), QModule::Do(), QDriver::Do(), QReaderEventGeneratorFiller::Do(), QFilter::Filter(), MFlagCoincidence::Init(), MSorter::Init(), MTimeSort::Init(), QDriver::Init(), QFileReader::Init(), QNeighboursFiller::Init(), QReaderEventGeneratorFiller::Init(), QFileWriter::Init(), and QReader::ReadFilesList().

◆ Process()

virtual bool QBaseModule::Process	(	QEventAssembler &	ev,
		QEventList &	evl,
		const bool	exec,
		QEventList &	ovl
	)

pure virtual

Process method is called for each event, getting the event and as argument and must be implemented by inheriting classes.

Implemented in QWriter, QReader, QModule, QDriver, and QFilter.

Referenced by ProcessBase().

◆ ProcessBase()

bool QBaseModule::ProcessBase	(	QEventAssembler &	ev,
		QEventList &	evl,
		const bool	exec,
		QEventList &	ovl
	)

ProcessBase method is called for each event, getting the event and as argument.

Definition at line 128 of file QBaseModule.cc.

References fExecuted, fLabel, QModuleTimeProfiling::fProcessCalls, QModuleTimeProfiling::fProcessTime, QModuleTimeProfiling::GetTimeProfilingOn(), QModuleTimeProfiling::GetTimer(), QSequence::GlobalData(), my_sequence, Process(), QModuleTimeProfiling::ResetTimer(), QGlobalDataManager::SetOwner(), QEventAssembler::SetOwner(), and QEventList::Size().

Referenced by QSequence::Run().

◆ SetNeedNeighbours()

void QBaseModule::SetNeedNeighbours ( bool need )

inlineprotected

set wheter this module needs neighbours

Definition at line 169 of file QBaseModule.hh.

References fNeedNeighbours.

Referenced by QFilter::Begin(), QWriter::Begin(), QDriver::Begin(), QModule::Begin(), QModule::Do(), and QFilter::Filter().

◆ SetRunAgain()

void QBaseModule::SetRunAgain ( bool b )

inline

Set that the sequence will be reiterated.

Definition at line 120 of file QBaseModule.hh.

References b, my_sequence, and QSequence::SetRunAgain().

Referenced by MCoincidenceTiming::Done(), MFlagCoincidence::Done(), QModule::End(), and QDriver::HandleAction().

◆ SetVerbosity()

void QBaseModule::SetVerbosity ( MsgLevel l = WarnMsg )

inlineprivate

Definition at line 195 of file QBaseModule.hh.

References verbosity.

◆ Update()

void QBaseModule::Update	(	QSequence *	s,
		unsigned int	occurrence
	)

set the occurrence in the same sequence. MV FIXME: should not be public

Definition at line 34 of file QBaseModule.cc.

References Demangle(), Driver, fConfig, Filter, QModuleConfig::fLabel, fMessageName, QModuleConfig::fName, fName, QModuleConfig::fOccurrence, fOccurrence, QModuleConfig::fSequenceName, QModuleConfig::fSoftwareRevision, QModuleConfig::fType, fType, QModuleConfig::fVersionTag, QOptions::GetInstance(), QNamed::GetName(), GetName(), GetOccurrence(), QOptions::GetParameter(), GetSequence(), QVdt::GetString(), Module, my_sequence, Reader, QOptions::SetParameter(), and Writer.

◆ UpdateConfigParameters()

void QBaseModule::UpdateConfigParameters ( const std::string & p ) const

private

update module config

Definition at line 333 of file QBaseModule.cc.

References fConfig, QModuleConfig::fParameters, QOptions::GetInstance(), GetName(), GetOccurrence(), QOptions::GetParameter(), GetSequence(), and QVdt::GetString().

Referenced by GetBool(), GetDouble(), GetInt(), GetString(), GetVectorBool(), GetVectorDouble(), GetVectorInt(), and GetVectorString().

◆ UpdateEnableFlag()

void QBaseModule::UpdateEnableFlag ( )

inlineprivate

update enable flag

Definition at line 173 of file QBaseModule.hh.

References fEnabled, and GetBool().

Referenced by QSequence::Dump().

◆ Warn()

void QBaseModule::Warn	(	const char *	descr,
			...
	)		const

inline

Send a warning message (an error that the framework can recover) with printf syntax.

Definition at line 228 of file QBaseModule.hh.

References fMessageName, QMessageHandler::Get(), QMessageHandler::Send(), verbosity, and WarnMsg.

Referenced by BeginBase(), QFileWriter::BuildFileName(), MCoincidenceMultiplicity::Do(), QFileWriter::Do(), GetBool(), GetDouble(), GetInt(), GetString(), GetVectorBool(), GetVectorDouble(), GetVectorInt(), GetVectorString(), and QFileWriter::IsToOpen().

Friends And Related Function Documentation

◆ QDriver

friend class QDriver

friend

Definition at line 203 of file QBaseModule.hh.

◆ QFilter

friend class QFilter

friend

Definition at line 204 of file QBaseModule.hh.

◆ QModFactory

template<class T >

friend class QModFactory

friend

Definition at line 197 of file QBaseModule.hh.

◆ QModule

friend class QModule

friend

Definition at line 201 of file QBaseModule.hh.

◆ QModuleFactory

friend class QModuleFactory

friend

Definition at line 199 of file QBaseModule.hh.

◆ QSequence

friend class QSequence

friend

Definition at line 200 of file QBaseModule.hh.

◆ QWriter

friend class QWriter

friend

Definition at line 202 of file QBaseModule.hh.

Member Data Documentation

◆ fConfig

QModuleConfig QBaseModule::fConfig

mutableprivate

Definition at line 191 of file QBaseModule.hh.

Referenced by BeginBase(), GetConfig(), Update(), and UpdateConfigParameters().

◆ fEnabled

bool QBaseModule::fEnabled

private

Definition at line 184 of file QBaseModule.hh.

Referenced by Disable(), isEnabled(), QBaseModule(), and UpdateEnableFlag().

◆ fExecuted

bool QBaseModule::fExecuted

protected

Definition at line 163 of file QBaseModule.hh.

Referenced by QFilter::FilterAlgorithm(), QDriver::Process(), QModule::Process(), QReader::Process(), QWriter::Process(), and ProcessBase().

◆ fFirstCall

bool QBaseModule::fFirstCall

private

Definition at line 188 of file QBaseModule.hh.

◆ fLabel

std::string QBaseModule::fLabel

private

Definition at line 185 of file QBaseModule.hh.

Referenced by BeginBase(), EndBase(), QFilter::FilterAlgorithm(), GetLabel(), QModule::Process(), and ProcessBase().

◆ fMessageName

std::string QBaseModule::fMessageName

private

Definition at line 187 of file QBaseModule.hh.

Referenced by Debug(), Error(), Info(), Panic(), QBaseModule(), Update(), and Warn().

◆ fName

std::string QBaseModule::fName

private

Definition at line 186 of file QBaseModule.hh.

Referenced by BeginBase(), GetName(), QBaseModule(), and Update().

◆ fNeedNeighbours

bool QBaseModule::fNeedNeighbours

private

Definition at line 189 of file QBaseModule.hh.

Referenced by BeginBase(), EndBase(), NeedNeighbours(), QBaseModule(), and SetNeedNeighbours().

◆ fOccurrence

unsigned int QBaseModule::fOccurrence

private

Definition at line 183 of file QBaseModule.hh.

Referenced by GetOccurrence(), QBaseModule(), and Update().

◆ fRequiredLabels

std::vector<QEventLabel> QBaseModule::fRequiredLabels

private

Definition at line 193 of file QBaseModule.hh.

Referenced by BeginBase(), and GetRequiredLabels().

◆ fType

Type QBaseModule::fType

private

Definition at line 192 of file QBaseModule.hh.

Referenced by QBaseModule(), and Update().

◆ my_sequence

QSequence* QBaseModule::my_sequence

private

Definition at line 190 of file QBaseModule.hh.

Referenced by BeginBase(), EndBase(), GetIteration(), GetRunAgain(), GetSequence(), QDriver::GetSequence(), ProcessBase(), SetRunAgain(), and Update().

◆ verbosity

MsgLevel QBaseModule::verbosity

private

Definition at line 182 of file QBaseModule.hh.

Referenced by BeginBase(), Debug(), Error(), GetVerbosity(), Info(), Panic(), QBaseModule(), SetVerbosity(), and Warn().

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

pkg/dianaframework/QBaseModule.hh
pkg/dianaframework/QBaseModule.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ QBaseModule()

◆ ~QBaseModule()

Member Function Documentation

◆ Begin()

◆ BeginBase()

◆ Debug()

◆ Disable()

◆ End()

◆ EndBase()

◆ Error()

◆ GetBool()

◆ GetConfig()

◆ GetDouble()

◆ GetFullPath()

◆ GetInt()

◆ GetIteration()

◆ GetLabel()

◆ GetName()

◆ GetOccurrence()

◆ GetRequiredLabels()

◆ GetRunAgain()

◆ GetSequence()

◆ GetString()

◆ GetVectorBool()

◆ GetVectorDouble()

◆ GetVectorInt()

◆ GetVectorString()

◆ GetVerbosity()

◆ GlobalData()

◆ Info()

◆ isEnabled()

◆ NeedNeighbours()

◆ Panic()

◆ Process()

◆ ProcessBase()

◆ SetNeedNeighbours()

◆ SetRunAgain()

◆ SetVerbosity()

◆ Update()

◆ UpdateConfigParameters()

◆ UpdateEnableFlag()

◆ Warn()

Friends And Related Function Documentation

◆ QDriver

◆ QFilter

◆ QModFactory

◆ QModule

◆ QModuleFactory

◆ QSequence

◆ QWriter

Member Data Documentation

◆ fConfig

◆ fEnabled

◆ fExecuted

◆ fFirstCall

◆ fLabel

◆ fMessageName

◆ fName

◆ fNeedNeighbours

◆ fOccurrence

◆ fRequiredLabels

◆ fType

◆ my_sequence

◆ verbosity