allpix::ROOTObjectReaderModule

Module: Modules

Module to read data stored in ROOT file back to allpix messages. More…

#include <ROOTObjectReaderModule.hpp>

Public Types

	Name
using std::map< std::type_index, std::function< std::shared_ptr< BaseMessage >(std::vector< Object * >, std::shared_ptr< Detector >)> >	MessageCreatorMap

Public Functions

	Name
	ROOTObjectReaderModule(Configuration & config, Messenger * messenger, GeometryManager * geo_mgr) Constructor for this unique module.
	~ROOTObjectReaderModule() override Destructor deletes the internal objects read from ROOT Tree.
virtual void	initialize() override Open the ROOT file containing the stored output data.
virtual void	run(Event * event) override Convert the objects stored for the current event to messages.
virtual void	finalize() override Output summary and close the ROOT file.

Additional inherited members

Public Functions inherited from allpix::Module

	Name
	Module(const Module & ) =delete Copying a module is not allowed.
Module &	operator=(const Module & ) =delete Copying a module is not allowed.
	Module(Module && ) =delete Disallow move behaviour (not possible with references)
Module &	operator=(Module && ) =delete Disallow move behaviour (not possible with references)
	Module(Configuration & config) Base constructor for unique modules.
	Module(Configuration & config, std::shared_ptr< Detector > detector) Base constructor for detector modules.
virtual	~Module() Essential virtual destructor.
std::shared_ptr< Detector >	getDetector() const Get the detector linked to this module.
std::string	getUniqueName() const Get the unique name of this module.
std::string	createOutputFile(const std::string & pathname, const std::string & extension ="", bool global =false, bool delete_file =false) Create and return an absolute path to be used for output from a relative path.
TDirectory *	getROOTDirectory() const Get ROOT directory which should be used to output histograms et cetera.
ConfigManager *	getConfigManager() const Get the config manager object to allow to read the global and other module configurations.
bool	multithreadingEnabled() const Returns if multithreading of this module is enabled.
virtual void	initializeThread() Initialize the module for each thread after the global initialization.
virtual void	finalizeThread() Finalize the module after the event sequence for each thread.

Protected Functions inherited from allpix::Module

	Name
void	allow_multithreading() Enable multithreading for this module.
Configuration &	get_configuration() Get the module configuration for internal use.

Protected Attributes inherited from allpix::Module

	Name
Configuration &	config_

Friends inherited from allpix::Module

	Name
class	Event
class	ModuleManager
class	Messenger
class	LocalMessenger

Detailed Description

class allpix::ROOTObjectReaderModule;

Module to read data stored in ROOT file back to allpix messages.

Reads the tree of objects in the data format of the ROOTObjectWriterModule. Converts all the stored objects that are supported back to messages containing those objects and dispatches those messages.

Public Types Documentation

using MessageCreatorMap

using allpix::ROOTObjectReaderModule::MessageCreatorMap =  std::map<std::type_index, std::function<std::shared_ptr<BaseMessage>(std::vector<Object*>, std::shared_ptr<Detector>)> >;

Public Functions Documentation

function ROOTObjectReaderModule

ROOTObjectReaderModule(
    Configuration & config,
    Messenger * messenger,
    GeometryManager * geo_mgr
)

Constructor for this unique module.

Parameters:

config Configuration object for this module as retrieved from the steering file
messenger Pointer to the messenger object to allow binding to messages on the bus
geo_mgr Pointer to the geometry manager, containing the detectors

function ~ROOTObjectReaderModule

~ROOTObjectReaderModule() override

Destructor deletes the internal objects read from ROOT Tree.

Note: Objects cannot be stored in smart pointers due to internal ROOT logic

function initialize

virtual void initialize() override

Open the ROOT file containing the stored output data.

Reimplements: allpix::Module::initialize

function run

virtual void run(
    Event * event
) override

Convert the objects stored for the current event to messages.

Reimplements: allpix::Module::run

function finalize

virtual void finalize() override

Output summary and close the ROOT file.

Reimplements: allpix::Module::finalize

Updated on 2025-02-27 at 14:14:46 +0000