allpix::DepositionLaserModule

Module: Modules

#include <DepositionLaserModule.hpp>

Public Functions

	Name
	DepositionLaserModule(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for this unique module.
virtual void	initialize() override Initialization method of the module.
virtual void	run(Event * event) override Run method of the module.
virtual void	finalize() override Finalize and write optional histograms.

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

class allpix::DepositionLaserModule;

Module to do function.

More detailed explanation of module

DepositionLaserModule(
    Configuration & config,
    Messenger * messenger,
    GeometryManager * geo_manager
)

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_manager Pointer to the geometry manager, containing the detectors

virtual void initialize() override

Initialization method of the module.

Reimplements: allpix::Module::initialize

virtual void run(
    Event * event
) override

Run method of the module.

Reimplements: allpix::Module::run

virtual void finalize() override

Finalize and write optional histograms.

Reimplements: allpix::Module::finalize

Updated on 2024-12-13 at 08:31:37 +0000