Writes trigger configuration from FHiCL into a data product. More...

Inheritance diagram for icarus::TriggerConfigurationExtraction:

Classes
struct	Config
	Configuration of the module. More...

Public Types
using	Parameters = art::EDProducer::Table< Config >

Public Member Functions
	TriggerConfigurationExtraction (Parameters const &config)
	Constructor: just reads the configuration. More...

virtual void	beginRun (art::Run &run) override
	Action on new run: configuration is written. More...

virtual void	produce (art::Event &) override
	Mandatory method, unused. More...

Private Member Functions
bool	checkConsistency (icarus::TriggerConfiguration const &newConfig, std::string const &srcName) const
	Throws an exception if the `newConfig` is not compatible with the current. More...

Private Attributes
std::optional < icarus::TriggerConfiguration >	fTriggerConfig
	Current Trigger configuration (may be still unassigned). More...

bool	fRequireConsistency = true
	Whether trigger configuration inconsistency is fatal. More...

std::string	fTriggerFragmentType
	Name of the trigger fragment type. More...

bool	fVerbose = false
	Whether to print the configuration we read. More...

std::string	fLogCategory
	Category tag for messages. More...

Detailed Description

Writes trigger configuration from FHiCL into a data product.

This module reads the configuration related to the Trigger from the FHiCL configuration of the input runs and puts it into each run as a data product.

Input

This module requires any input with art run objects in it. The format expected for that configuration is defined in icarus::TriggerConfigurationExtractor, which is the utility used for the actual extraction.

Output

A data product of type icarus::TriggerConfiguration is placed in each run. Note that the module itself does not enforce any coherence in the configuration.

Configuration parameters

The following configuration parameters are supported:

TriggerFragmentType (string, default: ICARUSTriggerV2): name of the type of trigger fragment, used to identify the configuration of the trigger.
Verbose (flag, default: false): if set to true, it will print in full the configuration of the trigger the first time it is read and each time a different one is found.
LogCategory (string, default: ICARUSConfigurationExtraction): category tag used for messages to message facility.

Multithreading

This module does not support multithreading, and art does not provide multithreading for its functionality anyway: the only action is performed at run and input file level, and the only concurrency in art is currently (art 3.7) at event level.

Definition at line 83 of file TriggerConfigurationExtraction_module.cc.

Member Typedef Documentation

using icarus::TriggerConfigurationExtraction::Parameters = art::EDProducer::Table<Config>

Definition at line 122 of file TriggerConfigurationExtraction_module.cc.

Constructor & Destructor Documentation

icarus::TriggerConfigurationExtraction::TriggerConfigurationExtraction ( Parameters const & config )

Constructor: just reads the configuration.

Definition at line 148 of file TriggerConfigurationExtraction_module.cc.

   : art::EDProducer(config)
   , fTriggerFragmentType(config().TriggerFragmentType())
   , fVerbose(config().Verbose())
   , fLogCategory(config().LogCategory())
 {
   
   // no consummation here (except for FHiCL configuration)
   
   produces<icarus::TriggerConfiguration, art::InRun>();
   
 } // icarus::TriggerConfigurationExtraction::ICARUSTriggerConfigurationExtraction()

Member Function Documentation

void icarus::TriggerConfigurationExtraction::beginRun ( art::Run & run )

overridevirtual

Action on new run: configuration is written.

Definition at line 163 of file TriggerConfigurationExtraction_module.cc.

                                                                {
   
   icarus::TriggerConfiguration config = extractTriggerReadoutConfiguration
     (run, icarus::TriggerConfigurationExtractor{ fTriggerFragmentType });
   
   checkConsistency(config, "run " + std::to_string(run.run()));
   if (!fTriggerConfig.has_value() && fVerbose)
     mf::LogInfo(fLogCategory) << "Trigger readout:" << config;
   
   fTriggerConfig = std::move(config);
   
   // put a copy of the current configuration
   run.put(std::make_unique<icarus::TriggerConfiguration>(fTriggerConfig.value()));
   
 } // icarus::riggerConfigurationExtraction::beginRun()

bool icarus::TriggerConfigurationExtraction::checkConsistency	(	icarus::TriggerConfiguration const &	newConfig,
		std::string const &	srcName
	)		const

private

Throws an exception if the newConfig is not compatible with the current.

Definition at line 182 of file TriggerConfigurationExtraction_module.cc.

 {
   if (!fTriggerConfig.has_value() || (*fTriggerConfig == config)) return true;
   
   // see debug information for more details
   if (fRequireConsistency) {
     throw cet::exception("icarus::TriggerConfigurationExtraction")
       << "Configuration from " << srcName
       << " is incompatible with the previously found configuration.\n"
       ;
   } // if consistency is required
   
   mf::LogWarning(fLogCategory)
     << "Configuration from " << srcName
     << " is incompatible with the previously found configuration.\n"
     ;
   if (fVerbose) mf::LogVerbatim(fLogCategory) << "Trigger readout:" << config;
   return false;
   
   
 } // icarus::TriggerConfigurationExtraction::checkConsistency()