artdaq  v3_00_03
artdaq::BuildInfo< instanceName, Pkgs > Class Template Reference

BuildInfo is an art::EDProducer which saves information about package builds to the data file. More...

#include <artdaq/ArtModules/BuildInfo_module.hh>

Inheritance diagram for artdaq::BuildInfo< instanceName, Pkgs >:

Public Member Functions

 BuildInfo (fhicl::ParameterSet const &p)
 BuildInfo module Constructor. More...
 
virtual ~BuildInfo ()=default
 Default Destructor.
 
void beginRun (art::Run &r) override
 Perform actions at the beginning of the Run. More...
 
void produce (art::Event &e) override
 Perform actions for each event. More...
 

Detailed Description

template<std::string * instanceName, typename... Pkgs>
class artdaq::BuildInfo< instanceName, Pkgs >

BuildInfo is an art::EDProducer which saves information about package builds to the data file.

Template Parameters
instanceNameTag which the BuildInfo objects will be saved under
PkgsList of package BuildInfo types

Definition at line 19 of file BuildInfo_module.hh.

Constructor & Destructor Documentation

template<std::string * instanceName, typename... Pkgs>
artdaq::BuildInfo< instanceName, Pkgs >::BuildInfo ( fhicl::ParameterSet const &  p)
explicit

BuildInfo module Constructor.

Parameters
pParameterSet used to configure BuildInfo module

BuildInfo_module expects the following Parameters: "instance_name": Name which the BuildInfo information will be saved under

Definition at line 82 of file BuildInfo_module.hh.

Member Function Documentation

template<std::string * instanceName, typename... Pkgs>
void artdaq::BuildInfo< instanceName, Pkgs >::beginRun ( art::Run &  r)
override

Perform actions at the beginning of the Run.

Parameters
rart::Run object

The BuildInfo information is stored in the Run-level provenance, so this method performs most of the "work" for this module.

Definition at line 92 of file BuildInfo_module.hh.

template<std::string * instanceName, typename... Pkgs>
void artdaq::BuildInfo< instanceName, Pkgs >::produce ( art::Event &  e)
override

Perform actions for each event.

Parameters
eart::Event object

This function is a required override for EDProducer, and is a No-Op in BuildInfo_module.

Definition at line 112 of file BuildInfo_module.hh.


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