Data provider for Root file written by RootPersistenceService. More...

#include <RootDataProvider.h>

Inheritance diagram for EA::RootDataProvider:

Classes
struct	EvObjInfo

struct	GlobObjInfo

Public Member Functions
	RootDataProvider (const std::string &name, const std::string &dataSource)
	Constructor. More...

bool	Connect () override
	Connects to the input file(s). More...

bool	Disconnect () override
	Closes the input file(s). More...

RetrievalResult	GetObject (const std::string &name, ObjectCategory category, ObjectWrapper &wrapper, std::string &actualName) override
	Retrieve the requested data object for current event. More...

bool	SetCurrentEvent (unsigned int event, std::vector< std::string > &notValidGlobalObjects) override
	Set the current event. More...

virtual std::vector< std::string >	FreeObjects (const std::vector< std::string > &objs, Memory::Status memStatus) override
	Free the memory for given objects. More...

Public Member Functions inherited from EA::DataProvider
	DataProvider (const std::string &name, const std::string &dataSource)
	Constructor. More...

virtual	~DataProvider ()
	Destructor. More...

virtual RetrievalResult	GetObject (const std::string &name, ObjectCategory category, ObjectWrapper &wrapper)
	Retrieve the requested data object for current event. More...

virtual bool	SetCurrentEvent (unsigned int event)
	Set the current event. More...

virtual bool	SetCurrentPass (unsigned int pass, unsigned int iteration)
	Set the current processing pass. More...

const std::string &	GetDataSource ()
	Getter for data source string. More...

Public Member Functions inherited from EA::Info
	Info (const std::string &name)
	Constructor. More...

virtual	~Info ()
	Destructor. More...

virtual const std::string	GetType () const

virtual const std::string	GetName () const
	The type (i.e. class) of the object. More...

virtual const std::string	GetVersion () const
	The name of the object. More...

Public Member Functions inherited from EA::Configurable
	Configurable ()
	Constructor. More...

template<typename T >
bool	SetParameter (const std::string &name, const T &value)
	Set the value of a parameter. More...

bool	SetParameter (const std::string &name, const char *value)
	Set the value of a string parameter using a string literal. More...

std::vector< std::string >	GetParameters ()
	Get the names of the parameters. More...

Public Member Functions inherited from EA::ObjectProducer
	ObjectProducer ()
	Constructor. More...

virtual	~ObjectProducer ()
	Destructor. More...

void	DeclareProducedObject (std::string name, ObjectCategory category, std::string alias, std::string store)
	Declare a produced objects. More...

const ProducedObjects &	GetProducedObjects () const
	Getter method for produced objects. More...

Protected Member Functions
observer_ptr< TFile >	GetCurrentFile ()
	Getter method for the current input file. More...

observer_ptr< TChain >	GetEventChain ()
	Getter method for the event chain. More...

Protected Member Functions inherited from EA::Info
	Info (const std::shared_ptr< Representation > &impl)

std::shared_ptr< Representation > &	GetRepresentation ()

Protected Member Functions inherited from EA::Configurable
template<typename T >
bool	DefineParameter (const std::string &name, T &variable)
	Set a parameter. More...

	Configurable (const std::shared_ptr< Representation > &impl)

std::shared_ptr< Representation > &	GetRepresentation ()

Protected Member Functions inherited from EA::ObjectProducer
	ObjectProducer (const std::shared_ptr< Representation > &impl)

std::shared_ptr< Representation > &	GetRepresentation ()

Private Types
using	EvObjectsBook = std::unordered_map< std::string, EvObjInfo >

using	GlobObjectsBook = std::unordered_map< std::string, GlobObjInfo >

Private Attributes
EvObjectsBook	_eventBook

GlobObjectsBook	_globalBook

TChain *	_eventChain

unsigned int	_currentEvent

bool	_withoutTree

TFile *	_fileWoTree

Long64_t	_treeReadEntry

Int_t	_treeNumber

Additional Inherited Members
Public Types inherited from EA::ObjectProducer
using	ProducedObjects = std::vector< ProducedObject >
	Type for container of produced objects. More...

Detailed Description

Data provider for Root file written by RootPersistenceService.

This data provider reads event, pass and global objects from a Root file produced by the RootPersistenceService.

Member Typedef Documentation

◆ EvObjectsBook

using EA::RootDataProvider::EvObjectsBook = std::unordered_map<std::string, EvObjInfo>

private

◆ GlobObjectsBook

using EA::RootDataProvider::GlobObjectsBook = std::unordered_map<std::string, GlobObjInfo>

private

Constructor & Destructor Documentation

◆ RootDataProvider()

EA::RootDataProvider::RootDataProvider	(	const std::string &	name,
		const std::string &	dataSource
	)

Constructor.

The dataSource parameter must be a name of a Root file created with #RootPersistenceService, or a txt file containing a list of Root files to be chained.

Parameters

name	The name of the data provider.
dataSource	A Root file created with #RootPersistenceService

Member Function Documentation

◆ Connect()

bool EA::RootDataProvider::Connect ( )

overridevirtual

Connects to the input file(s).

Opens the input file(s) passed as data source to the constructor and sets all the contained objects as produced by the data provider. If a list of Root files has been given then this method will return false if there are inconsistencies between files or if one of them does not have any event object.

Returns: true if the data source file has the right format and has been correctly opened for input.

Reimplemented from EA::DataProvider.

◆ Disconnect()

bool EA::RootDataProvider::Disconnect ( )

overridevirtual

Closes the input file(s).

Returns: true if the file(s) have been correctly closed.

Reimplemented from EA::DataProvider.

◆ FreeObjects()

std::vector< std::string > EA::RootDataProvider::FreeObjects	(	const std::vector< std::string > &	objs,
		Memory::Status	memStatus
	)

overridevirtual

Free the memory for given objects.

This override of DataProvider::FreeObjects will delete all the event objects in the objs vector if the memory status is EXHAUSTED. Nothing is done if the memory status is less severe.

Parameters

objs	The list of objects whose memory can be freed.

Returns: A list of objects whose memory has been released.

See also: #Memory::GetState

Reimplemented from EA::ObjectProducer.

◆ GetCurrentFile()

observer_ptr< TFile > EA::RootDataProvider::GetCurrentFile ( )

protected

Getter method for the current input file.

Derived classes can use this method to get access to the current input file.

Returns: A pointer to the current input file.

◆ GetEventChain()

observer_ptr<TChain> EA::RootDataProvider::GetEventChain ( )

inlineprotected

Getter method for the event chain.

Derived classes can use this method to get access to the input event chain.

Returns: A pointer to the event chain.

◆ GetObject()

RetrievalResult EA::RootDataProvider::GetObject	(	const std::string &	name,
		ObjectCategory	category,
		ObjectWrapper &	wrapper,
		std::string &	actualName
	)

overridevirtual

Retrieve the requested data object for current event.

The possible return values are:

RetrievalResult::SUCCESS if the requested object has been found
RetrievalResult::NOTAVAILABLE if the requested object exists but is not available for current event/pass
RetrievalResult::BADCLASS if the requested object exists but does not match the class specified in #wrapper
RetrievalResult::NOTFOUND if the requested object does not exist
RetrievalResult::ERROR if an error occurred during object retrieval

In case of RetrievalResult::SUCCESS, the requested object is returned to the caller by means of the wrapper parameter; if the data provider recognizes the name of the requested parameter as an alias then it can return the actual object name by setting the actualName parameter. In any other case wrapper must be set equal to nullptr and actualName to "".

In case the data provider does not support aliases then it is sufficient (although not necessary) to override the GetObject(const std::string &, ObjectCategory, ObjectWrapper &) overload and not this method.

Technical note: this is the GetObject overload called by the framework.

Parameters

name	The name of the object.
category	The category of the object to be retrieved (ObjectCategory::EVENT, ObjectCategory::PASS or ObjectCategory::GLOBAL).
wrapper	Return wrapper for the desired object (wraps nothing if the object is non-existent or not available for the current event).
actualName	the actual object name, in case `name` has been recognized as an alias.

Returns: the outcome of the retrieve operation.

Reimplemented from EA::DataProvider.

◆ SetCurrentEvent()

bool EA::RootDataProvider::SetCurrentEvent	(	unsigned int	event,
		std::vector< std::string > &	notValidGlobalObjects
	)

overridevirtual

Set the current event.

This method can be used to communicate to the data provider the number of the current event. Subsequent calls to the GetObject method will load the data objects for the given event. In case the requested event is not available (e.g. there are less events than required) then the returned value will be false.

A list of global objects that were already provided by the provider in previous events, and that will need to be provided again for the current event, can be passed to the caller by filling the notValidGlobalObjects vector parameter. This can be useful to inform the caller about those global objects that needs to be re-read from the data source for the current event (e.g. the caller can remove them from the data store and thus a subsequent request from an algorithm will be passed to the data provider that could in turn provide the new version). Providers encompassing this possibility should override this method.

Parameters

event	The number of the current event.
notValidGlobalObjects	A list of global objects which are not valid and will be removed from data stores.

Returns: true if the requested event is available, false otherwise.

Reimplemented from EA::DataProvider.

Member Data Documentation

◆ _currentEvent

unsigned int EA::RootDataProvider::_currentEvent

private

◆ _eventBook

EvObjectsBook EA::RootDataProvider::_eventBook

private

◆ _eventChain

TChain* EA::RootDataProvider::_eventChain

private

◆ _fileWoTree

TFile* EA::RootDataProvider::_fileWoTree

private

◆ _globalBook

GlobObjectsBook EA::RootDataProvider::_globalBook

private

◆ _treeNumber

Int_t EA::RootDataProvider::_treeNumber

private

◆ _treeReadEntry

Long64_t EA::RootDataProvider::_treeReadEntry

private

◆ _withoutTree

bool EA::RootDataProvider::_withoutTree

private

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

/builds/mori/EventAnalysis/include/data/RootDataProvider.h
/builds/mori/EventAnalysis/src/data/RootDataProvider.cpp

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EvObjectsBook

◆ GlobObjectsBook

Constructor & Destructor Documentation

◆ RootDataProvider()

Member Function Documentation

◆ Connect()

◆ Disconnect()

◆ FreeObjects()

◆ GetCurrentFile()

◆ GetEventChain()

◆ GetObject()

◆ SetCurrentEvent()

Member Data Documentation

◆ _currentEvent

◆ _eventBook

◆ _eventChain

◆ _fileWoTree

◆ _globalBook

◆ _treeNumber

◆ _treeReadEntry

◆ _withoutTree