Abstract class for diana readers. More...

Inheritance diagram for QFileReader:

Public Member Functions
	QFileReader ()
	Mandatory constructor. More...

virtual	~QFileReader ()
	destructor More...

virtual const QError &	JumpToEvent (Long64_t event)
	Jump to event. More...

void	Init (QEventAssembler &eva)
	Init method is called before event loop, getting the QEventAssembler as argument This method must be implemented by inheriting classes. More...

bool	Do (Diana::QEventAssembler &eva)

void	Done ()
	Done method is called after event loop. This method must be implemented by inheriting classes. More...

unsigned int	GetReadNumber () const
	Get read number (entry number in file being read, starting from 0) More...

Public Member Functions inherited from QReader
	QReader ()
	constructor More...

virtual	~QReader ()
	destructor More...

virtual bool	Do (QEventAssembler &eva)=0
	Do method is called for each event, getting the QEventAssembler as argument. This method must be implemented by inheriting classes. More...

const int &	GetFileNumber ()
	Get Current file number, used by QWriter (throug QSequence) More...

bool	DoBase (QEventAssembler &eva)
	DoBase executes Do, and is called by QNeighboursFiller. More...

bool	NeighboursOn ()

Public Member Functions inherited from QBaseModule
	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...

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...

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

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

Protected Member Functions
virtual void	Add (const std::string &fileName, QEventAssembler &eva)=0
	Add objects to File, called only once in the Init phase. More...

virtual void	Open (const std::string &fileName, QEventAssembler &eva)=0
	Open File. More...

virtual bool	Fill (QEventAssembler &eva)=0
	Fill event, return false when file has no more events. More...

virtual void	Close ()=0

Protected Member Functions inherited from QReader
void	InitFileManager ()
	Initialize multiple and single file management. More...

void	OpenNewFile (const std::string &fileName)
	Call it when opening new file. More...

Protected Member Functions inherited from QBaseModule
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
std::list< std::string >	fFileList
	list of files More...

unsigned int	fFileEventNumber
	last event read More...

bool	fReadFileList
	read file list More...

std::string	fFileListPath
	file list path More...

Protected Attributes inherited from QReader
int	fFileNumber
	current file number read More...

std::vector< std::string >	fFileList
	list of files More...

bool	fReadFileList
	read file list More...

std::string	fFileListPath
	file list path More...

unsigned int	fProcessedNumber
	events processed More...

int	fEventNumberPrintStep
	print event number step More...

QError	fErr
	Error returned by methods. More...

QRWCommon *	fRWCommon
	object to share file names with QWriter More...

Protected Attributes inherited from QBaseModule
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 Attributes
std::list< std::string >::const_iterator	fFileListIter

Friends
class	QSequence

Additional Inherited Members
Public Types inherited from QBaseModule
enum	Type { Module , Filter , Reader , Writer , Driver }

Static Public Member Functions inherited from QReader
static std::list< std::string >	GetFilesList ()
	list of input files More...

Static Protected Attributes inherited from QReader
static std::list< std::string >	fFullPathFilesList
	list of files More...

Detailed Description

Abstract class for diana readers.

Author: Marco Vignati

Definition at line 19 of file QFileReader.hh.

Constructor & Destructor Documentation

◆ QFileReader()

Q_BEGIN_NAMESPACE QFileReader::QFileReader ( )

Mandatory constructor.

Definition at line 8 of file QFileReader.cc.

◆ ~QFileReader()

QFileReader::~QFileReader ( )

virtual

destructor

Definition at line 12 of file QFileReader.cc.

Member Function Documentation

◆ Add()

virtual void QFileReader::Add	(	const std::string &	fileName,
		QEventAssembler &	eva
	)

protectedpure virtual

Add objects to File, called only once in the Init phase.

Referenced by Init().

◆ Close()

virtual void QFileReader::Close ( )

protectedpure virtual

Referenced by Do().

◆ Do()

bool QFileReader::Do ( Diana::QEventAssembler & eva )

Definition at line 57 of file QFileReader.cc.

References Close(), fFileEventNumber, fFileList, fFileListIter, Fill(), QBaseModule::Info(), Open(), and QReader::OpenNewFile().

◆ Done()

void QFileReader::Done ( )

virtual

Done method is called after event loop. This method must be implemented by inheriting classes.

Implements QReader.

Definition at line 81 of file QFileReader.cc.

◆ Fill()

virtual bool QFileReader::Fill ( QEventAssembler & eva )

protectedpure virtual

Fill event, return false when file has no more events.

Referenced by Do().

◆ GetReadNumber()

unsigned int QFileReader::GetReadNumber ( ) const

inline

Get read number (entry number in file being read, starting from 0)

Definition at line 39 of file QFileReader.hh.

References fFileEventNumber.

◆ Init()

void QFileReader::Init ( QEventAssembler & eva )

virtual

Init method is called before event loop, getting the QEventAssembler as argument This method must be implemented by inheriting classes.

Implements QReader.

Definition at line 16 of file QFileReader.cc.

References Add(), QBaseModule::Debug(), fFileEventNumber, fFileList, fFileListIter, fFileListPath, QReader::fFileNumber, QReader::fFullPathFilesList, QRWCommon::fReaderFileNumber, fReadFileList, QReader::fRWCommon, QRWCommon::fTempOutputFileList, QBaseModule::GetIteration(), QBaseModule::GetString(), QBaseModule::Panic(), and QFileList::Read().

◆ JumpToEvent()

const QError & QFileReader::JumpToEvent ( Long64_t event )

virtual

Jump to event.

Parameters

event

Returns: error

Reimplemented from QReader.

Definition at line 85 of file QFileReader.cc.

References QReader::fErr, QBaseModule::GetName(), QERR_NOT_IMPLEMENTED, and QError::SetDescription().

◆ Open()

virtual void QFileReader::Open	(	const std::string &	fileName,
		QEventAssembler &	eva
	)

protectedpure virtual

Open File.

Referenced by Do().

Friends And Related Function Documentation

◆ QSequence

friend class QSequence

friend

Definition at line 64 of file QFileReader.hh.

Member Data Documentation

◆ fFileEventNumber

unsigned int QFileReader::fFileEventNumber

protected

last event read

Definition at line 54 of file QFileReader.hh.

Referenced by Do(), GetReadNumber(), and Init().

◆ fFileList

std::list<std::string> QFileReader::fFileList

protected

list of files

Definition at line 51 of file QFileReader.hh.

Referenced by Do(), and Init().

◆ fFileListIter

std::list<std::string>::const_iterator QFileReader::fFileListIter

private

Definition at line 62 of file QFileReader.hh.

Referenced by Do(), and Init().

◆ fFileListPath

std::string QFileReader::fFileListPath

protected

file list path

Definition at line 59 of file QFileReader.hh.

Referenced by Init().

◆ fReadFileList

bool QFileReader::fReadFileList

protected

read file list

Definition at line 57 of file QFileReader.hh.

Referenced by Init().

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

pkg/dianaframework/QFileReader.hh
pkg/dianaframework/QFileReader.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QFileReader()

◆ ~QFileReader()

Member Function Documentation

◆ Add()

◆ Close()

◆ Do()

◆ Done()

◆ Fill()

◆ GetReadNumber()

◆ Init()

◆ JumpToEvent()

◆ Open()

Friends And Related Function Documentation

◆ QSequence

Member Data Documentation

◆ fFileEventNumber

◆ fFileList

◆ fFileListIter

◆ fFileListPath

◆ fReadFileList