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>

List of all members.

Classes

struct  fill_packages< Arg >
struct  fill_packages< Arg, Args...>

Public Member Functions

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

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:
instanceName Tag which the BuildInfo objects will be saved under
Pkgs List 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  )  [inline, explicit]

BuildInfo module Constructor.

Parameters:
p ParameterSet 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  )  [inline, override]

Perform actions at the beginning of the Run.

Parameters:
r art::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  )  [inline, override]

Perform actions for each event.

Parameters:
e art::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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator

Generated on 23 May 2017 for artdaq by  doxygen 1.6.1